ConsulEndpointBuilderFactory.ConsulEndpointBuilder (Camel

All Superinterfaces:

ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder, ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

ConsulEndpointBuilderFactory
```
public static interface ConsulEndpointBuilderFactory.ConsulEndpointBuilder
extends ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder, ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
```
Builder for endpoint for the Consul component.

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`aclToken(String aclToken)` Sets the ACL token to be used with Consul.
`default ConsulEndpointBuilderFactory.AdvancedConsulEndpointBuilder`	`advanced()`
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`connectTimeout(Duration connectTimeout)` Connect timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`connectTimeout(String connectTimeout)` Connect timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`connectTimeoutMillis(Long connectTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`connectTimeoutMillis(String connectTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`consulClient(Object consulClient)` Reference to a com.orbitz.consul.Consul in the registry.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`consulClient(String consulClient)` Reference to a com.orbitz.consul.Consul in the registry.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`key(String key)` The default key.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`password(String password)` Sets the password to be used for basic authentication.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`pingInstance(boolean pingInstance)` Configure if the AgentClient should attempt a ping before returning the Consul instance.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`pingInstance(String pingInstance)` Configure if the AgentClient should attempt a ping before returning the Consul instance.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`readTimeout(Duration readTimeout)` Read timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`readTimeout(String readTimeout)` Read timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`readTimeoutMillis(Long readTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`readTimeoutMillis(String readTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`sslContextParameters(Object sslContextParameters)` SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`sslContextParameters(String sslContextParameters)` SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`tags(Set<String> tags)` Set tags.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`tags(String tags)` Set tags.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`url(String url)` The Consul agent URL.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`userName(String userName)` Sets the username to be used for basic authentication.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`writeTimeout(Duration writeTimeout)` Write timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`writeTimeout(String writeTimeout)` Write timeout for OkHttpClient.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`writeTimeoutMillis(Long writeTimeoutMillis)` Deprecated.
`default ConsulEndpointBuilderFactory.ConsulEndpointBuilder`	`writeTimeoutMillis(String writeTimeoutMillis)` Deprecated.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
blockSeconds, blockSeconds, bridgeErrorHandler, bridgeErrorHandler, firstIndex, firstIndex, recursive, recursive

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

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
action, lazyStartProducer, lazyStartProducer, valueAsString, valueAsString

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

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

- Method Detail
  - advanced
```
default ConsulEndpointBuilderFactory.AdvancedConsulEndpointBuilder advanced()
```
    Specified by:
    
    advanced in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    advanced in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
  - connectTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder connectTimeout(Duration connectTimeout)
```
    Connect timeout for OkHttpClient. The option is a: <code>java.time.Duration</code> type. Group: common
    
    Specified by:
    
    connectTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    connectTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    connectTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - connectTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder connectTimeout(String connectTimeout)
```
    Connect timeout for OkHttpClient. The option will be converted to a <code>java.time.Duration</code> type. Group: common
    
    Specified by:
    
    connectTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    connectTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    connectTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - connectTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    connectTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    connectTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    connectTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - connectTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    connectTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    connectTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    connectTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - consulClient
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    consulClient in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    consulClient in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    consulClient - the value to set
    
    Returns:
    
    the dsl builder
  - consulClient
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    consulClient in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    consulClient in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    consulClient - the value to set
    
    Returns:
    
    the dsl builder
  - key
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder key(String key)
```
    The default key. Can be overridden by CamelConsulKey. The option is a: <code>java.lang.String</code> type. Group: common
    
    Specified by:
    
    key in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    key in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    key - the value to set
    
    Returns:
    
    the dsl builder
  - pingInstance
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    pingInstance in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    pingInstance in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    pingInstance - the value to set
    
    Returns:
    
    the dsl builder
  - pingInstance
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    pingInstance in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    pingInstance in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    pingInstance - the value to set
    
    Returns:
    
    the dsl builder
  - readTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder readTimeout(Duration readTimeout)
```
    Read timeout for OkHttpClient. The option is a: <code>java.time.Duration</code> type. Group: common
    
    Specified by:
    
    readTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    readTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    readTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - readTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder readTimeout(String readTimeout)
```
    Read timeout for OkHttpClient. The option will be converted to a <code>java.time.Duration</code> type. Group: common
    
    Specified by:
    
    readTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    readTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    readTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - readTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    readTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    readTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    readTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - readTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    readTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    readTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    readTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - tags
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    tags in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    tags in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    tags - the value to set
    
    Returns:
    
    the dsl builder
  - tags
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    tags in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    tags in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    tags - the value to set
    
    Returns:
    
    the dsl builder
  - url
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder url(String url)
```
    The Consul agent URL. The option is a: <code>java.lang.String</code> type. Group: common
    
    Specified by:
    
    url in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    url in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    url - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder writeTimeout(Duration writeTimeout)
```
    Write timeout for OkHttpClient. The option is a: <code>java.time.Duration</code> type. Group: common
    
    Specified by:
    
    writeTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    writeTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    writeTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder writeTimeout(String writeTimeout)
```
    Write timeout for OkHttpClient. The option will be converted to a <code>java.time.Duration</code> type. Group: common
    
    Specified by:
    
    writeTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    writeTimeout in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    writeTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    writeTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    writeTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    writeTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - writeTimeoutMillis
```
@Deprecated
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    writeTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    writeTimeoutMillis in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    writeTimeoutMillis - the value to set
    
    Returns:
    
    the dsl builder
  - aclToken
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder aclToken(String aclToken)
```
    Sets the ACL token to be used with Consul. The option is a: <code>java.lang.String</code> type. Group: security
    
    Specified by:
    
    aclToken in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    aclToken in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    aclToken - the value to set
    
    Returns:
    
    the dsl builder
  - password
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder password(String password)
```
    Sets the password to be used for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
    
    Specified by:
    
    password in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    password in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    password - the value to set
    
    Returns:
    
    the dsl builder
  - sslContextParameters
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    sslContextParameters in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    sslContextParameters in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    sslContextParameters - the value to set
    
    Returns:
    
    the dsl builder
  - sslContextParameters
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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
    
    Specified by:
    
    sslContextParameters in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    sslContextParameters in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    sslContextParameters - the value to set
    
    Returns:
    
    the dsl builder
  - userName
```
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder userName(String userName)
```
    Sets the username to be used for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
    
    Specified by:
    
    userName in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder
    
    Specified by:
    
    userName in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
    
    Parameters:
    
    userName - the value to set
    
    Returns:
    
    the dsl builder

Interface ConsulEndpointBuilderFactory.ConsulEndpointBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

connectTimeout

connectTimeout

connectTimeoutMillis

connectTimeoutMillis

consulClient

consulClient

key

pingInstance

pingInstance

readTimeout

readTimeout

readTimeoutMillis

readTimeoutMillis

tags

tags

url

writeTimeout

writeTimeout

writeTimeoutMillis

writeTimeoutMillis

aclToken

password

sslContextParameters

sslContextParameters

userName