The camel consul component allows you to work with Consul, a distributed, highly available, datacenter-aware, service discovery and configuration system.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| apiEndpoint | path | common | true | java.lang.String | The API endpoint | ||
| connectTimeoutMillis | parameter | common | java.lang.Long | Connect timeout for OkHttpClient | |||
| dc | parameter | common | java.lang.String | The data center | |||
| key | parameter | common | java.lang.String | The default key. Can be overridden by CamelConsulKey | |||
| pingInstance | parameter | common | true | boolean | Configure if the AgentClient should attempt a ping before returning the Consul instance | ||
| readTimeoutMillis | parameter | common | java.lang.Long | Read timeout for OkHttpClient | |||
| tags | parameter | common | java.lang.String | Set tags. You can separate multiple tags by comma. | |||
| url | parameter | common | java.lang.String | The Consul agent URL | |||
| writeTimeoutMillis | parameter | common | java.lang.Long | Write timeout for OkHttpClient | |||
| bridgeErrorHandler | parameter | consumer | boolean | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| action | parameter | producer | java.lang.String | The default action. Can be overridden by CamelConsulAction | |||
| valueAsString | parameter | producer | false | boolean | Default to transform values retrieved from Consul i.e. on KV endpoint to string. | ||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| blockSeconds | parameter | watch | 10 | java.lang.Integer | The second to wait for a watch event, default 10 seconds | ||
| firstIndex | parameter | watch | 0 | long | The first index for watch for, default 0 | ||
| recursive | parameter | watch | false | boolean | Recursively watch, default false | ||
| aclToken | parameter | security | java.lang.String | Sets the ACL token to be used with Consul | |||
| password | parameter | security | java.lang.String | Sets the password to be used for basic authentication | |||
| sslContextParameters | parameter | security | org.apache.camel.util.jsse.SSLContextParameters | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance. | |||
| userName | parameter | security | java.lang.String | Sets the username to be used for basic authentication |