All Superinterfaces:

ComponentBuilder<org.apache.camel.component.consul.ConsulComponent>

All Known Implementing Classes:

ConsulComponentBuilderFactory.ConsulComponentBuilderImpl

Enclosing interface:

ConsulComponentBuilderFactory
```
public static interface ConsulComponentBuilderFactory.ConsulComponentBuilder
extends ComponentBuilder<org.apache.camel.component.consul.ConsulComponent>
```
Builder for the Consul component.

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`aclToken(String aclToken)`	Sets the ACL token to be used with Consul.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`action(String action)`	The default action.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)`	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`blockSeconds(Integer blockSeconds)`	The second to wait for a watch event, default 10 seconds.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)`	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.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`configuration(org.apache.camel.component.consul.ConsulConfiguration configuration)`	Consul configuration.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`connectTimeout(Duration connectTimeout)`	Connect timeout for OkHttpClient.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`connectTimeoutMillis(Long connectTimeoutMillis)`	Deprecated.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`consistencyMode(com.orbitz.consul.option.ConsistencyMode consistencyMode)`	The consistencyMode used for queries, default ConsistencyMode.DEFAULT.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`consulClient(com.orbitz.consul.Consul consulClient)`	Reference to a com.orbitz.consul.Consul in the registry.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`datacenter(String datacenter)`	The data center.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`firstIndex(BigInteger firstIndex)`	The first index for watch for, default 0.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`key(String key)`	The default key.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)`	Whether the producer should be started lazy (on the first message).
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`nearNode(String nearNode)`	The near node to use for queries.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`nodeMeta(List<String> nodeMeta)`	The note meta-data to use for queries.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`password(String password)`	Sets the password to be used for basic authentication.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`pingInstance(boolean pingInstance)`	Configure if the AgentClient should attempt a ping before returning the Consul instance.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`readTimeout(Duration readTimeout)`	Read timeout for OkHttpClient.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`readTimeoutMillis(Long readTimeoutMillis)`	Deprecated.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`recursive(boolean recursive)`	Recursively watch, default false.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)`	SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`tags(String tags)`	Set tags.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`url(String url)`	The Consul agent URL.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`useGlobalSslContextParameters(boolean useGlobalSslContextParameters)`	Enable usage of global SSL context parameters.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`userName(String userName)`	Sets the username to be used for basic authentication.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`valueAsString(boolean valueAsString)`	Default to transform values retrieved from Consul i.e.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`writeTimeout(Duration writeTimeout)`	Write timeout for OkHttpClient.
`default ConsulComponentBuilderFactory.ConsulComponentBuilder`	`writeTimeoutMillis(Long writeTimeoutMillis)`	Deprecated.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - connectTimeout
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder connectTimeout(Duration connectTimeout)
```
    Connect timeout for OkHttpClient. The option is a: java.time.Duration type. Group: common
  - connectTimeoutMillis
```
@Deprecated
default ConsulComponentBuilderFactory.ConsulComponentBuilder connectTimeoutMillis(Long connectTimeoutMillis)
```
    Deprecated.
    
    Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead. The option is a: java.lang.Long type. Group: common
  - consulClient
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder consulClient(com.orbitz.consul.Consul consulClient)
```
    Reference to a com.orbitz.consul.Consul in the registry. The option is a: com.orbitz.consul.Consul type. Group: common
  - key
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder key(String key)
```
    The default key. Can be overridden by CamelConsulKey. The option is a: java.lang.String type. Group: common
  - pingInstance
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder pingInstance(boolean pingInstance)
```
    Configure if the AgentClient should attempt a ping before returning the Consul instance. The option is a: boolean type. Default: true Group: common
  - readTimeout
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder readTimeout(Duration readTimeout)
```
    Read timeout for OkHttpClient. The option is a: java.time.Duration type. Group: common
  - readTimeoutMillis
```
@Deprecated
default ConsulComponentBuilderFactory.ConsulComponentBuilder readTimeoutMillis(Long readTimeoutMillis)
```
    Deprecated.
    
    Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead. The option is a: java.lang.Long type. Group: common
  - tags
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder tags(String tags)
```
    Set tags. You can separate multiple tags by comma. The option is a: java.lang.String type. Group: common
  - url
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder url(String url)
```
    The Consul agent URL. The option is a: java.lang.String type. Group: common
  - writeTimeout
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder writeTimeout(Duration writeTimeout)
```
    Write timeout for OkHttpClient. The option is a: java.time.Duration type. Group: common
  - writeTimeoutMillis
```
@Deprecated
default ConsulComponentBuilderFactory.ConsulComponentBuilder writeTimeoutMillis(Long writeTimeoutMillis)
```
    Deprecated.
    
    Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead. The option is a: java.lang.Long type. Group: common
  - bridgeErrorHandler
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    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. The option is a: boolean type. Default: false Group: consumer
  - action
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder action(String action)
```
    The default action. Can be overridden by CamelConsulAction. The option is a: java.lang.String type. Group: producer
  - lazyStartProducer
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer
  - valueAsString
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder valueAsString(boolean valueAsString)
```
    Default to transform values retrieved from Consul i.e. on KV endpoint to string. The option is a: boolean type. Default: false Group: producer
  - basicPropertyBinding
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - configuration
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder configuration(org.apache.camel.component.consul.ConsulConfiguration configuration)
```
    Consul configuration. The option is a: org.apache.camel.component.consul.ConsulConfiguration type. Group: advanced
  - consistencyMode
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder consistencyMode(com.orbitz.consul.option.ConsistencyMode consistencyMode)
```
    The consistencyMode used for queries, default ConsistencyMode.DEFAULT. The option is a: com.orbitz.consul.option.ConsistencyMode type. Default: DEFAULT Group: advanced
  - datacenter
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder datacenter(String datacenter)
```
    The data center. The option is a: java.lang.String type. Group: advanced
  - nearNode
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder nearNode(String nearNode)
```
    The near node to use for queries. The option is a: java.lang.String type. Group: advanced
  - nodeMeta
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder nodeMeta(List<String> nodeMeta)
```
    The note meta-data to use for queries. The option is a: java.util.List type. Group: advanced
  - aclToken
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder aclToken(String aclToken)
```
    Sets the ACL token to be used with Consul. The option is a: java.lang.String type. Group: security
  - password
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder password(String password)
```
    Sets the password to be used for basic authentication. The option is a: java.lang.String type. Group: security
  - sslContextParameters
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
```
    SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
  - useGlobalSslContextParameters
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
```
    Enable usage of global SSL context parameters. The option is a: boolean type. Default: false Group: security
  - userName
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder userName(String userName)
```
    Sets the username to be used for basic authentication. The option is a: java.lang.String type. Group: security
  - blockSeconds
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder blockSeconds(Integer blockSeconds)
```
    The second to wait for a watch event, default 10 seconds. The option is a: java.lang.Integer type. Default: 10 Group: watch
  - firstIndex
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder firstIndex(BigInteger firstIndex)
```
    The first index for watch for, default 0. The option is a: java.math.BigInteger type. Default: 0 Group: watch
  - recursive
```
default ConsulComponentBuilderFactory.ConsulComponentBuilder recursive(boolean recursive)
```
    Recursively watch, default false. The option is a: boolean type. Default: false Group: watch

Interface ConsulComponentBuilderFactory.ConsulComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

connectTimeout

connectTimeoutMillis

consulClient

key

pingInstance

readTimeout

readTimeoutMillis

tags

url

writeTimeout

writeTimeoutMillis

bridgeErrorHandler

action

lazyStartProducer

valueAsString

basicPropertyBinding

configuration

consistencyMode

datacenter

nearNode

nodeMeta

aclToken

password

sslContextParameters

useGlobalSslContextParameters

userName

blockSeconds

firstIndex

recursive