ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

ConsulEndpointBuilderFactory.ConsulEndpointBuilder

Enclosing interface:

ConsulEndpointBuilderFactory
```
public static interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the Consul component.

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`aclToken(String aclToken)` Sets the ACL token to be used with Consul.
`default ConsulEndpointBuilderFactory.AdvancedConsulEndpointConsumerBuilder`	`advanced()`
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`blockSeconds(Integer blockSeconds)` The second to wait for a watch event, default 10 seconds.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`blockSeconds(String blockSeconds)` The second to wait for a watch event, default 10 seconds.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`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 ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`bridgeErrorHandler(String 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 ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`connectTimeout(Duration connectTimeout)` Connect timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`connectTimeout(String connectTimeout)` Connect timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`connectTimeoutMillis(Long connectTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`connectTimeoutMillis(String connectTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`consulClient(Object consulClient)` Reference to a com.orbitz.consul.Consul in the registry.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`consulClient(String consulClient)` Reference to a com.orbitz.consul.Consul in the registry.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`firstIndex(BigInteger firstIndex)` The first index for watch for, default 0.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`firstIndex(String firstIndex)` The first index for watch for, default 0.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`key(String key)` The default key.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`password(String password)` Sets the password to be used for basic authentication.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`pingInstance(boolean pingInstance)` Configure if the AgentClient should attempt a ping before returning the Consul instance.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`pingInstance(String pingInstance)` Configure if the AgentClient should attempt a ping before returning the Consul instance.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`readTimeout(Duration readTimeout)` Read timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`readTimeout(String readTimeout)` Read timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`readTimeoutMillis(Long readTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`readTimeoutMillis(String readTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`recursive(boolean recursive)` Recursively watch, default false.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`recursive(String recursive)` Recursively watch, default false.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`sslContextParameters(Object sslContextParameters)` SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`sslContextParameters(String sslContextParameters)` SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`tags(Set<String> tags)` Set tags.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`tags(String tags)` Set tags.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`url(String url)` The Consul agent URL.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`userName(String userName)` Sets the username to be used for basic authentication.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`writeTimeout(Duration writeTimeout)` Write timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`writeTimeout(String writeTimeout)` Write timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`writeTimeoutMillis(Long writeTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder`	`writeTimeoutMillis(String writeTimeoutMillis)` Deprecated.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default ConsulEndpointBuilderFactory.AdvancedConsulEndpointConsumerBuilder advanced()
```
  - connectTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder connectTimeout(Duration connectTimeout)
```
    Connect timeout for OkHttpClient. The option is a: <code>java.time.Duration</code> type. Group: common
    
    Parameters:
    
    connectTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - connectTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder connectTimeout(String connectTimeout)
```
    Connect timeout for OkHttpClient. The option will be converted to a <code>java.time.Duration</code> type. Group: common
    
    Parameters:
    
    connectTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - connectTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder connectTimeoutMillis(Long connectTimeoutMillis)
```
    Deprecated.
    
    Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead. The option is a: <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    connectTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - connectTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder connectTimeoutMillis(String connectTimeoutMillis)
```
    Deprecated.
    
    Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead. The option will be converted to a <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    connectTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - consulClient
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder consulClient(Object consulClient)
```
    Reference to a com.orbitz.consul.Consul in the registry. The option is a: <code>com.orbitz.consul.Consul</code> type. Group: common
    
    Parameters:
    
    consulClient - the value to set
    
    Returns:
    
    the dsl builder
  - consulClient
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder consulClient(String consulClient)
```
    Reference to a com.orbitz.consul.Consul in the registry. The option will be converted to a <code>com.orbitz.consul.Consul</code> type. Group: common
    
    Parameters:
    
    consulClient - the value to set
    
    Returns:
    
    the dsl builder
  - key
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder key(String key)
```
    The default key. Can be overridden by CamelConsulKey. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    key - the value to set
    
    Returns:
    
    the dsl builder
  - pingInstance
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder pingInstance(boolean pingInstance)
```
    Configure if the AgentClient should attempt a ping before returning the Consul instance. The option is a: <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    pingInstance - the value to set
    
    Returns:
    
    the dsl builder
  - pingInstance
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder pingInstance(String pingInstance)
```
    Configure if the AgentClient should attempt a ping before returning the Consul instance. The option will be converted to a <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    pingInstance - the value to set
    
    Returns:
    
    the dsl builder
  - readTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder readTimeout(Duration readTimeout)
```
    Read timeout for OkHttpClient. The option is a: <code>java.time.Duration</code> type. Group: common
    
    Parameters:
    
    readTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - readTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder readTimeout(String readTimeout)
```
    Read timeout for OkHttpClient. The option will be converted to a <code>java.time.Duration</code> type. Group: common
    
    Parameters:
    
    readTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - readTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder readTimeoutMillis(Long readTimeoutMillis)
```
    Deprecated.
    
    Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead. The option is a: <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    readTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - readTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder readTimeoutMillis(String readTimeoutMillis)
```
    Deprecated.
    
    Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead. The option will be converted to a <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    readTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - tags
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder tags(Set<String> tags)
```
    Set tags. You can separate multiple tags by comma. The option is a: <code>java.util.Set<java.lang.String></code> type. Group: common
    
    Parameters:
    
    tags - the value to set
    
    Returns:
    
    the dsl builder
  - tags
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder tags(String tags)
```
    Set tags. You can separate multiple tags by comma. The option will be converted to a <code>java.util.Set<java.lang.String></code> type. Group: common
    
    Parameters:
    
    tags - the value to set
    
    Returns:
    
    the dsl builder
  - url
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder url(String url)
```
    The Consul agent URL. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    url - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder writeTimeout(Duration writeTimeout)
```
    Write timeout for OkHttpClient. The option is a: <code>java.time.Duration</code> type. Group: common
    
    Parameters:
    
    writeTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder writeTimeout(String writeTimeout)
```
    Write timeout for OkHttpClient. The option will be converted to a <code>java.time.Duration</code> type. Group: common
    
    Parameters:
    
    writeTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder writeTimeoutMillis(Long writeTimeoutMillis)
```
    Deprecated.
    
    Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead. The option is a: <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    writeTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder writeTimeoutMillis(String writeTimeoutMillis)
```
    Deprecated.
    
    Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead. The option will be converted to a <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    writeTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - aclToken
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder aclToken(String aclToken)
```
    Sets the ACL token to be used with Consul. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    aclToken - the value to set
    
    Returns:
    
    the dsl builder
  - password
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder password(String password)
```
    Sets the password to be used for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    password - the value to set
    
    Returns:
    
    the dsl builder
  - sslContextParameters
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)
```
    SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
    
    Parameters:
    
    sslContextParameters - the value to set
    
    Returns:
    
    the dsl builder
  - sslContextParameters
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder sslContextParameters(String sslContextParameters)
```
    SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
    
    Parameters:
    
    sslContextParameters - the value to set
    
    Returns:
    
    the dsl builder
  - userName
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder userName(String userName)
```
    Sets the username to be used for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    userName - the value to set
    
    Returns:
    
    the dsl builder
  - blockSeconds
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder blockSeconds(Integer blockSeconds)
```
    The second to wait for a watch event, default 10 seconds. The option is a: <code>java.lang.Integer</code> type. Default: 10 Group: watch
    
    Parameters:
    
    blockSeconds - the value to set
    
    Returns:
    
    the dsl builder
  - blockSeconds
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder blockSeconds(String blockSeconds)
```
    The second to wait for a watch event, default 10 seconds. The option will be converted to a <code>java.lang.Integer</code> type. Default: 10 Group: watch
    
    Parameters:
    
    blockSeconds - the value to set
    
    Returns:
    
    the dsl builder
  - firstIndex
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder firstIndex(BigInteger firstIndex)
```
    The first index for watch for, default 0. The option is a: <code>java.math.BigInteger</code> type. Default: 0 Group: watch
    
    Parameters:
    
    firstIndex - the value to set
    
    Returns:
    
    the dsl builder
  - firstIndex
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder firstIndex(String firstIndex)
```
    The first index for watch for, default 0. The option will be converted to a <code>java.math.BigInteger</code> type. Default: 0 Group: watch
    
    Parameters:
    
    firstIndex - the value to set
    
    Returns:
    
    the dsl builder
  - recursive
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder recursive(boolean recursive)
```
    Recursively watch, default false. The option is a: <code>boolean</code> type. Default: false Group: watch
    
    Parameters:
    
    recursive - the value to set
    
    Returns:
    
    the dsl builder
  - recursive
```
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder recursive(String recursive)
```
    Recursively watch, default false. The option will be converted to a <code>boolean</code> type. Default: false Group: watch
    
    Parameters:
    
    recursive - the value to set
    
    Returns:
    
    the dsl builder

Interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

connectTimeout

connectTimeout

connectTimeoutMillis

connectTimeoutMillis

consulClient

consulClient

key

pingInstance

pingInstance

readTimeout

readTimeout

readTimeoutMillis

readTimeoutMillis

tags

tags

url

writeTimeout

writeTimeout

writeTimeoutMillis

writeTimeoutMillis

bridgeErrorHandler

bridgeErrorHandler

aclToken

password

sslContextParameters

sslContextParameters

userName

blockSeconds

blockSeconds

firstIndex

firstIndex

recursive

recursive