ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

ConsulEndpointBuilderFactory.ConsulEndpointBuilder

Enclosing interface:

ConsulEndpointBuilderFactory
```
public static interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint producers for the Consul component.

Method Summary

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

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.AdvancedConsulEndpointProducerBuilder advanced()
```
  - connectTimeout
```
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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
  - action
```
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder action(String action)
```
    The default action. Can be overridden by CamelConsulAction. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    action - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder lazyStartProducer(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - valueAsString
```
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder valueAsString(boolean valueAsString)
```
    Default to transform values retrieved from Consul i.e. on KV endpoint to string. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    valueAsString - the value to set
    
    Returns:
    
    the dsl builder
  - valueAsString
```
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder valueAsString(String valueAsString)
```
    Default to transform values retrieved from Consul i.e. on KV endpoint to string. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    valueAsString - the value to set
    
    Returns:
    
    the dsl builder
  - aclToken
```
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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.ConsulEndpointProducerBuilder 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

Interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder

Method Summary

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

action

lazyStartProducer

lazyStartProducer

valueAsString

valueAsString

aclToken

password

sslContextParameters

sslContextParameters

userName