| {"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":"3.18.1","scheme":"consul","extendsScheme":"","syntax":"consul:apiEndpoint","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelConsulAction":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List<String>","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":{"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":{"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":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"com.orbitz.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":{"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":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"com.orbitz.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":{"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":{"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":{"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":{"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"},"connectTimeoutMillis":{"kind":"parameter","displayName":"Connect Timeout Millis","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":true,"deprecationNote":"Use connectTimeout instead","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead"},"consulClient":{"kind":"parameter","displayName":"Consul Client","group":"common","label":"common","required":false,"type":"object","javaType":"com.orbitz.consul.Consul","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Reference to a com.orbitz.consul.Consul in the registry."},"key":{"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":{"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":{"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"},"readTimeoutMillis":{"kind":"parameter","displayName":"Read Timeout Millis","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":true,"deprecationNote":"Use readTimeout instead","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead"},"tags":{"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":{"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":{"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"},"writeTimeoutMillis":{"kind":"parameter","displayName":"Write Timeout Millis","group":"common","label":"","required":false,"type":"duration","javaType":"java.lang.Long","deprecated":true,"deprecationNote":"Use writeTimeout instead","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.consul.ConsulConfiguration","configurationField":"configuration","description":"Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead"},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"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":{"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":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the 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":{"kind":"parameter","displayName":"Consistency Mode","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.orbitz.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":{"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":{"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":{"kind":"parameter","displayName":"Node Meta","group":"advanced","label":"advanced","required":false,"type":"array","javaType":"java.util.List<java.lang.String>","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":{"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":{"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":{"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":{"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":{"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":{"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":{"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"}}} |