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

Interface ConsulEndpointBuilderFactory.ConsulEndpointBuilder

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

Modifier and Type	Method	Description
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder	aclToken(String aclToken)	Sets the ACL token to be used with Consul.
default ConsulEndpointBuilderFactory.AdvancedConsulEndpointBuilder	advanced()
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder	connectTimeout(String connectTimeout)	Connect timeout.
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder	connectTimeout(Duration connectTimeout)	Connect timeout.
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(String readTimeout)	Read timeout.
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder	readTimeout(Duration readTimeout)	Read timeout.
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder	sslContextParameters(String sslContextParameters)	SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)	SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
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	valueAsString(boolean valueAsString)	Default to transform values retrieved from Consul i.e. on KV endpoint to string.
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder	valueAsString(String valueAsString)	Default to transform values retrieved from Consul i.e. on KV endpoint to string.
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder	writeTimeout(String writeTimeout)	Write timeout.
default ConsulEndpointBuilderFactory.ConsulEndpointBuilder	writeTimeout(Duration writeTimeout)	Write timeout.

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

blockSeconds, blockSeconds, firstIndex, firstIndex, recursive, recursive

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

action

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Details

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. The option is a: java.time.Duration 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. The option will be converted to a java.time.Duration 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

key

default ConsulEndpointBuilderFactory.ConsulEndpointBuilder key(String key)

The default key. Can be overridden by CamelConsulKey. The option is a: java.lang.String 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: boolean 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 boolean 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. The option is a: java.time.Duration 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. The option will be converted to a java.time.Duration 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

tags

default ConsulEndpointBuilderFactory.ConsulEndpointBuilder tags(String tags)

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

valueAsString

default ConsulEndpointBuilderFactory.ConsulEndpointBuilder 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: common

Specified by:

valueAsString in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder

Specified by:

valueAsString in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder

Parameters:

valueAsString - the value to set

Returns:

the dsl builder

valueAsString

default ConsulEndpointBuilderFactory.ConsulEndpointBuilder valueAsString(String valueAsString)

Default to transform values retrieved from Consul i.e. on KV endpoint to string. The option will be converted to a boolean type. Default: false Group: common

Specified by:

valueAsString in interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder

Specified by:

valueAsString in interface ConsulEndpointBuilderFactory.ConsulEndpointProducerBuilder

Parameters:

valueAsString - the value to set

Returns:

the dsl builder

writeTimeout

default ConsulEndpointBuilderFactory.ConsulEndpointBuilder writeTimeout(Duration writeTimeout)

Write timeout. The option is a: java.time.Duration 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. The option will be converted to a java.time.Duration 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

aclToken

default ConsulEndpointBuilderFactory.ConsulEndpointBuilder aclToken(String aclToken)

Sets the ACL token to be used with Consul. The option is a: java.lang.String 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: java.lang.String 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(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

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 org.apache.camel.support.jsse.SSLContextParameters 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: java.lang.String 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