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

Interface ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder

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

Modifier and Type	Method	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	connectTimeout(String connectTimeout)	Connect timeout.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	connectTimeout(Duration connectTimeout)	Connect timeout.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	firstIndex(String firstIndex)	The first index for watch for, default 0.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	firstIndex(BigInteger 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(String readTimeout)	Read timeout.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	readTimeout(Duration readTimeout)	Read timeout.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	recursive(boolean recursive)	Recursively watch, default false.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	recursive(String recursive)	Recursively watch, default false.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	sslContextParameters(String sslContextParameters)	SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)	SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.
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	valueAsString(boolean valueAsString)	Default to transform values retrieved from Consul i.e. on KV endpoint to string.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	valueAsString(String valueAsString)	Default to transform values retrieved from Consul i.e. on KV endpoint to string.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	writeTimeout(String writeTimeout)	Write timeout.
default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder	writeTimeout(Duration writeTimeout)	Write timeout.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Details

advanced

default ConsulEndpointBuilderFactory.AdvancedConsulEndpointConsumerBuilder advanced()

connectTimeout

default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder connectTimeout(Duration connectTimeout)

Connect timeout. The option is a: java.time.Duration type. Group: common

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

connectTimeout

default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder connectTimeout(String connectTimeout)

Connect timeout. The option will be converted to a java.time.Duration type. Group: common

Parameters:

connectTimeout - 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: java.lang.String 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: boolean 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 boolean type. Default: true Group: common

Parameters:

pingInstance - the value to set

Returns:

the dsl builder

readTimeout

default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder readTimeout(Duration readTimeout)

Read timeout. The option is a: java.time.Duration type. Group: common

Parameters:

readTimeout - the value to set

Returns:

the dsl builder

readTimeout

default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder readTimeout(String readTimeout)

Read timeout. The option will be converted to a java.time.Duration type. Group: common

Parameters:

readTimeout - 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 is a: java.lang.String 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: java.lang.String type. Group: common

Parameters:

url - the value to set

Returns:

the dsl builder

valueAsString

default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder 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

Parameters:

valueAsString - the value to set

Returns:

the dsl builder

valueAsString

default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder 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

Parameters:

valueAsString - the value to set

Returns:

the dsl builder

writeTimeout

default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder writeTimeout(Duration writeTimeout)

Write timeout. The option is a: java.time.Duration type. Group: common

Parameters:

writeTimeout - the value to set

Returns:

the dsl builder

writeTimeout

default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder writeTimeout(String writeTimeout)

Write timeout. The option will be converted to a java.time.Duration type. Group: common

Parameters:

writeTimeout - 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: java.lang.String 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: java.lang.String type. Group: security

Parameters:

password - the value to set

Returns:

the dsl builder

sslContextParameters

default ConsulEndpointBuilderFactory.ConsulEndpointConsumerBuilder 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

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 org.apache.camel.support.jsse.SSLContextParameters 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: java.lang.String 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: java.lang.Integer 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 java.lang.Integer 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: java.math.BigInteger 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 java.math.BigInteger 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: boolean 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 boolean type. Default: false Group: watch

Parameters:

recursive - the value to set

Returns:

the dsl builder