Consul

Integrate with Consul service discovery and configuration store.

Metadata

Property	Value
Scheme	`consul`
Support Level	Stable
Labels	cloud,api
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-consul</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`apiEndpoint`	string	✓		The API endpoint
`connectTimeout`	object			Connect timeout for OkHttpClient
`consulClient`	object			Reference to a org.kiwiproject.consul.Consul in the registry.
`key`	string			The default key. Can be overridden by CamelConsulKey
`pingInstance`	boolean		`true`	Configure if the AgentClient should attempt a ping before returning the Consul instance
`readTimeout`	object			Read timeout for OkHttpClient
`tags`	string			Set tags. You can separate multiple tags by comma.
`url`	string			The Consul agent URL
`writeTimeout`	object			Write timeout for OkHttpClient
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`action`	string			The default action. Can be overridden by CamelConsulAction
`valueAsString`	boolean		`false`	Default to transform values retrieved from Consul i.e. on KV endpoint to string.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the 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`	object		`DEFAULT`	The consistencyMode used for queries, default ConsistencyMode.DEFAULT
`datacenter`	string			The data center
`nearNode`	string			The near node to use for queries.
`nodeMeta`	array			The note meta-data to use for queries.
`aclToken`	string			Sets the ACL token to be used with Consul
`password`	string			Sets the password to be used for basic authentication
`sslContextParameters`	object			SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
`userName`	string			Sets the username to be used for basic authentication
`blockSeconds`	integer		`10`	The second to wait for a watch event, default 10 seconds
`firstIndex`	object		`0`	The first index for watch for, default 0
`recursive`	boolean		`false`	Recursively watch, default false