Package org.apache.camel.builder.endpoint.dsl

Interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder

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

Modifier and Type	Method	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(String connectTimeout)	Connect timeout for OkHttpClient.
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder	connectTimeout(Duration connectTimeout)	Connect timeout for OkHttpClient.
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder	consulClient(com.orbitz.consul.Consul 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	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(String readTimeout)	Read timeout for OkHttpClient.
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder	readTimeout(Duration readTimeout)	Read timeout for OkHttpClient.
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder	sslContextParameters(String sslContextParameters)	SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)	SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
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(String writeTimeout)	Write timeout for OkHttpClient.
default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder	writeTimeout(Duration writeTimeout)	Write timeout for OkHttpClient.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Details

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

consulClient

default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder consulClient(com.orbitz.consul.Consul 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

tags

default ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder tags(String tags)

Set tags. You can separate multiple tags by comma. The option is a: <code>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

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

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(org.apache.camel.support.jsse.SSLContextParameters 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