blob: ffe70a968382a7790ffe6beaf3205ad36839d508 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.builder.endpoint.dsl;
import java.util.Map;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.apache.camel.ExchangePattern;
import org.apache.camel.LoggingLevel;
import org.apache.camel.builder.EndpointConsumerBuilder;
import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
import org.apache.camel.spi.ExceptionHandler;
import org.apache.camel.spi.PollingConsumerPollStrategy;
import org.apache.camel.spi.ScheduledPollConsumerScheduler;
/**
* The camel etcd component allows you to work with Etcd, a distributed reliable
* key-value store.
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@Generated("org.apache.camel.maven.packaging.EndpointDslMojo")
public interface EtcdEndpointBuilderFactory {
/**
* Builder for endpoint consumers for the etcd component.
*/
public interface EtcdEndpointConsumerBuilder
extends
EndpointConsumerBuilder {
default AdvancedEtcdEndpointConsumerBuilder advanced() {
return (AdvancedEtcdEndpointConsumerBuilder) this;
}
/**
* To apply an action recursively.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default EtcdEndpointConsumerBuilder recursive(boolean recursive) {
setProperty("recursive", recursive);
return this;
}
/**
* To apply an action recursively.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default EtcdEndpointConsumerBuilder recursive(String recursive) {
setProperty("recursive", recursive);
return this;
}
/**
* The path to look for for service discovery.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default EtcdEndpointConsumerBuilder servicePath(String servicePath) {
setProperty("servicePath", servicePath);
return this;
}
/**
* To set the maximum time an action could take to complete.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: common
*/
default EtcdEndpointConsumerBuilder timeout(Long timeout) {
setProperty("timeout", timeout);
return this;
}
/**
* To set the maximum time an action could take to complete.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: common
*/
default EtcdEndpointConsumerBuilder timeout(String timeout) {
setProperty("timeout", timeout);
return this;
}
/**
* To set the URIs the client connects.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default EtcdEndpointConsumerBuilder uris(String uris) {
setProperty("uris", uris);
return this;
}
/**
* Allows for bridging the consumer to the Camel routing Error Handler,
* which mean any exceptions occurred while the consumer is trying to
* pickup incoming messages, or the likes, will now be processed as a
* message and handled by the routing Error Handler. By default the
* consumer will use the org.apache.camel.spi.ExceptionHandler to deal
* with exceptions, that will be logged at WARN or ERROR level and
* ignored.
*
* The option is a: <code>boolean</code> type.
*
* Group: consumer
*/
default EtcdEndpointConsumerBuilder bridgeErrorHandler(
boolean bridgeErrorHandler) {
setProperty("bridgeErrorHandler", bridgeErrorHandler);
return this;
}
/**
* Allows for bridging the consumer to the Camel routing Error Handler,
* which mean any exceptions occurred while the consumer is trying to
* pickup incoming messages, or the likes, will now be processed as a
* message and handled by the routing Error Handler. By default the
* consumer will use the org.apache.camel.spi.ExceptionHandler to deal
* with exceptions, that will be logged at WARN or ERROR level and
* ignored.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: consumer
*/
default EtcdEndpointConsumerBuilder bridgeErrorHandler(
String bridgeErrorHandler) {
setProperty("bridgeErrorHandler", bridgeErrorHandler);
return this;
}
/**
* To send an empty message in case of timeout watching for a key.
*
* The option is a: <code>boolean</code> type.
*
* Group: consumer
*/
default EtcdEndpointConsumerBuilder sendEmptyExchangeOnTimeout(
boolean sendEmptyExchangeOnTimeout) {
setProperty("sendEmptyExchangeOnTimeout", sendEmptyExchangeOnTimeout);
return this;
}
/**
* To send an empty message in case of timeout watching for a key.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: consumer
*/
default EtcdEndpointConsumerBuilder sendEmptyExchangeOnTimeout(
String sendEmptyExchangeOnTimeout) {
setProperty("sendEmptyExchangeOnTimeout", sendEmptyExchangeOnTimeout);
return this;
}
/**
* If the polling consumer did not poll any files, you can enable this
* option to send an empty message (no body) instead.
*
* The option is a: <code>boolean</code> type.
*
* Group: consumer
*/
default EtcdEndpointConsumerBuilder sendEmptyMessageWhenIdle(
boolean sendEmptyMessageWhenIdle) {
setProperty("sendEmptyMessageWhenIdle", sendEmptyMessageWhenIdle);
return this;
}
/**
* If the polling consumer did not poll any files, you can enable this
* option to send an empty message (no body) instead.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: consumer
*/
default EtcdEndpointConsumerBuilder sendEmptyMessageWhenIdle(
String sendEmptyMessageWhenIdle) {
setProperty("sendEmptyMessageWhenIdle", sendEmptyMessageWhenIdle);
return this;
}
/**
* The number of subsequent error polls (failed due some error) that
* should happen before the backoffMultipler should kick-in.
*
* The option is a: <code>int</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder backoffErrorThreshold(
int backoffErrorThreshold) {
setProperty("backoffErrorThreshold", backoffErrorThreshold);
return this;
}
/**
* The number of subsequent error polls (failed due some error) that
* should happen before the backoffMultipler should kick-in.
*
* The option will be converted to a <code>int</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder backoffErrorThreshold(
String backoffErrorThreshold) {
setProperty("backoffErrorThreshold", backoffErrorThreshold);
return this;
}
/**
* The number of subsequent idle polls that should happen before the
* backoffMultipler should kick-in.
*
* The option is a: <code>int</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder backoffIdleThreshold(
int backoffIdleThreshold) {
setProperty("backoffIdleThreshold", backoffIdleThreshold);
return this;
}
/**
* The number of subsequent idle polls that should happen before the
* backoffMultipler should kick-in.
*
* The option will be converted to a <code>int</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder backoffIdleThreshold(
String backoffIdleThreshold) {
setProperty("backoffIdleThreshold", backoffIdleThreshold);
return this;
}
/**
* To let the scheduled polling consumer backoff if there has been a
* number of subsequent idles/errors in a row. The multiplier is then
* the number of polls that will be skipped before the next actual
* attempt is happening again. When this option is in use then
* backoffIdleThreshold and/or backoffErrorThreshold must also be
* configured.
*
* The option is a: <code>int</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder backoffMultiplier(
int backoffMultiplier) {
setProperty("backoffMultiplier", backoffMultiplier);
return this;
}
/**
* To let the scheduled polling consumer backoff if there has been a
* number of subsequent idles/errors in a row. The multiplier is then
* the number of polls that will be skipped before the next actual
* attempt is happening again. When this option is in use then
* backoffIdleThreshold and/or backoffErrorThreshold must also be
* configured.
*
* The option will be converted to a <code>int</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder backoffMultiplier(
String backoffMultiplier) {
setProperty("backoffMultiplier", backoffMultiplier);
return this;
}
/**
* Milliseconds before the next poll. You can also specify time values
* using units, such as 60s (60 seconds), 5m30s (5 minutes and 30
* seconds), and 1h (1 hour).
*
* The option is a: <code>long</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder delay(long delay) {
setProperty("delay", delay);
return this;
}
/**
* Milliseconds before the next poll. You can also specify time values
* using units, such as 60s (60 seconds), 5m30s (5 minutes and 30
* seconds), and 1h (1 hour).
*
* The option will be converted to a <code>long</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder delay(String delay) {
setProperty("delay", delay);
return this;
}
/**
* If greedy is enabled, then the ScheduledPollConsumer will run
* immediately again, if the previous run polled 1 or more messages.
*
* The option is a: <code>boolean</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder greedy(boolean greedy) {
setProperty("greedy", greedy);
return this;
}
/**
* If greedy is enabled, then the ScheduledPollConsumer will run
* immediately again, if the previous run polled 1 or more messages.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder greedy(String greedy) {
setProperty("greedy", greedy);
return this;
}
/**
* Milliseconds before the first poll starts. You can also specify time
* values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30
* seconds), and 1h (1 hour).
*
* The option is a: <code>long</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder initialDelay(long initialDelay) {
setProperty("initialDelay", initialDelay);
return this;
}
/**
* Milliseconds before the first poll starts. You can also specify time
* values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30
* seconds), and 1h (1 hour).
*
* The option will be converted to a <code>long</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder initialDelay(String initialDelay) {
setProperty("initialDelay", initialDelay);
return this;
}
/**
* The consumer logs a start/complete log line when it polls. This
* option allows you to configure the logging level for that.
*
* The option is a: <code>org.apache.camel.LoggingLevel</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder runLoggingLevel(
LoggingLevel runLoggingLevel) {
setProperty("runLoggingLevel", runLoggingLevel);
return this;
}
/**
* The consumer logs a start/complete log line when it polls. This
* option allows you to configure the logging level for that.
*
* The option will be converted to a
* <code>org.apache.camel.LoggingLevel</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder runLoggingLevel(
String runLoggingLevel) {
setProperty("runLoggingLevel", runLoggingLevel);
return this;
}
/**
* Allows for configuring a custom/shared thread pool to use for the
* consumer. By default each consumer has its own single threaded thread
* pool.
*
* The option is a:
* <code>java.util.concurrent.ScheduledExecutorService</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder scheduledExecutorService(
ScheduledExecutorService scheduledExecutorService) {
setProperty("scheduledExecutorService", scheduledExecutorService);
return this;
}
/**
* Allows for configuring a custom/shared thread pool to use for the
* consumer. By default each consumer has its own single threaded thread
* pool.
*
* The option will be converted to a
* <code>java.util.concurrent.ScheduledExecutorService</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder scheduledExecutorService(
String scheduledExecutorService) {
setProperty("scheduledExecutorService", scheduledExecutorService);
return this;
}
/**
* To use a cron scheduler from either camel-spring or camel-quartz2
* component.
*
* The option is a:
* <code>org.apache.camel.spi.ScheduledPollConsumerScheduler</code>
* type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder scheduler(
ScheduledPollConsumerScheduler scheduler) {
setProperty("scheduler", scheduler);
return this;
}
/**
* To use a cron scheduler from either camel-spring or camel-quartz2
* component.
*
* The option will be converted to a
* <code>org.apache.camel.spi.ScheduledPollConsumerScheduler</code>
* type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder scheduler(String scheduler) {
setProperty("scheduler", scheduler);
return this;
}
/**
* To configure additional properties when using a custom scheduler or
* any of the Quartz2, Spring based scheduler.
*
* The option is a: <code>java.util.Map&lt;java.lang.String,
* java.lang.Object&gt;</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder schedulerProperties(
Map<String, Object> schedulerProperties) {
setProperty("schedulerProperties", schedulerProperties);
return this;
}
/**
* To configure additional properties when using a custom scheduler or
* any of the Quartz2, Spring based scheduler.
*
* The option will be converted to a
* <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code>
* type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder schedulerProperties(
String schedulerProperties) {
setProperty("schedulerProperties", schedulerProperties);
return this;
}
/**
* Whether the scheduler should be auto started.
*
* The option is a: <code>boolean</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder startScheduler(
boolean startScheduler) {
setProperty("startScheduler", startScheduler);
return this;
}
/**
* Whether the scheduler should be auto started.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder startScheduler(String startScheduler) {
setProperty("startScheduler", startScheduler);
return this;
}
/**
* Time unit for initialDelay and delay options.
*
* The option is a: <code>java.util.concurrent.TimeUnit</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder timeUnit(TimeUnit timeUnit) {
setProperty("timeUnit", timeUnit);
return this;
}
/**
* Time unit for initialDelay and delay options.
*
* The option will be converted to a
* <code>java.util.concurrent.TimeUnit</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder timeUnit(String timeUnit) {
setProperty("timeUnit", timeUnit);
return this;
}
/**
* Controls if fixed delay or fixed rate is used. See
* ScheduledExecutorService in JDK for details.
*
* The option is a: <code>boolean</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay) {
setProperty("useFixedDelay", useFixedDelay);
return this;
}
/**
* Controls if fixed delay or fixed rate is used. See
* ScheduledExecutorService in JDK for details.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: scheduler
*/
default EtcdEndpointConsumerBuilder useFixedDelay(String useFixedDelay) {
setProperty("useFixedDelay", useFixedDelay);
return this;
}
/**
* The password to use for basic authentication.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: security
*/
default EtcdEndpointConsumerBuilder password(String password) {
setProperty("password", password);
return this;
}
/**
* To configure security using SSLContextParameters.
*
* The option is a:
* <code>org.apache.camel.support.jsse.SSLContextParameters</code> type.
*
* Group: security
*/
default EtcdEndpointConsumerBuilder sslContextParameters(
Object sslContextParameters) {
setProperty("sslContextParameters", sslContextParameters);
return this;
}
/**
* To configure security using SSLContextParameters.
*
* The option will be converted to a
* <code>org.apache.camel.support.jsse.SSLContextParameters</code> type.
*
* Group: security
*/
default EtcdEndpointConsumerBuilder sslContextParameters(
String sslContextParameters) {
setProperty("sslContextParameters", sslContextParameters);
return this;
}
/**
* The user name to use for basic authentication.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: security
*/
default EtcdEndpointConsumerBuilder userName(String userName) {
setProperty("userName", userName);
return this;
}
}
/**
* Advanced builder for endpoint consumers for the etcd component.
*/
public interface AdvancedEtcdEndpointConsumerBuilder
extends
EndpointConsumerBuilder {
default EtcdEndpointConsumerBuilder basic() {
return (EtcdEndpointConsumerBuilder) this;
}
/**
* To let the consumer use a custom ExceptionHandler. Notice if the
* option bridgeErrorHandler is enabled then this option is not in use.
* By default the consumer will deal with exceptions, that will be
* logged at WARN or ERROR level and ignored.
*
* The option is a: <code>org.apache.camel.spi.ExceptionHandler</code>
* type.
*
* Group: consumer (advanced)
*/
default AdvancedEtcdEndpointConsumerBuilder exceptionHandler(
ExceptionHandler exceptionHandler) {
setProperty("exceptionHandler", exceptionHandler);
return this;
}
/**
* To let the consumer use a custom ExceptionHandler. Notice if the
* option bridgeErrorHandler is enabled then this option is not in use.
* By default the consumer will deal with exceptions, that will be
* logged at WARN or ERROR level and ignored.
*
* The option will be converted to a
* <code>org.apache.camel.spi.ExceptionHandler</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedEtcdEndpointConsumerBuilder exceptionHandler(
String exceptionHandler) {
setProperty("exceptionHandler", exceptionHandler);
return this;
}
/**
* Sets the exchange pattern when the consumer creates an exchange.
*
* The option is a: <code>org.apache.camel.ExchangePattern</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedEtcdEndpointConsumerBuilder exchangePattern(
ExchangePattern exchangePattern) {
setProperty("exchangePattern", exchangePattern);
return this;
}
/**
* Sets the exchange pattern when the consumer creates an exchange.
*
* The option will be converted to a
* <code>org.apache.camel.ExchangePattern</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedEtcdEndpointConsumerBuilder exchangePattern(
String exchangePattern) {
setProperty("exchangePattern", exchangePattern);
return this;
}
/**
* The index to watch from.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedEtcdEndpointConsumerBuilder fromIndex(Long fromIndex) {
setProperty("fromIndex", fromIndex);
return this;
}
/**
* The index to watch from.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedEtcdEndpointConsumerBuilder fromIndex(String fromIndex) {
setProperty("fromIndex", fromIndex);
return this;
}
/**
* A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing
* you to provide your custom implementation to control error handling
* usually occurred during the poll operation before an Exchange have
* been created and being routed in Camel.
*
* The option is a:
* <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedEtcdEndpointConsumerBuilder pollStrategy(
PollingConsumerPollStrategy pollStrategy) {
setProperty("pollStrategy", pollStrategy);
return this;
}
/**
* A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing
* you to provide your custom implementation to control error handling
* usually occurred during the poll operation before an Exchange have
* been created and being routed in Camel.
*
* The option will be converted to a
* <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedEtcdEndpointConsumerBuilder pollStrategy(
String pollStrategy) {
setProperty("pollStrategy", pollStrategy);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointConsumerBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
setProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointConsumerBuilder basicPropertyBinding(
String basicPropertyBinding) {
setProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointConsumerBuilder synchronous(
boolean synchronous) {
setProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointConsumerBuilder synchronous(
String synchronous) {
setProperty("synchronous", synchronous);
return this;
}
}
/**
* Builder for endpoint producers for the etcd component.
*/
public interface EtcdEndpointProducerBuilder
extends
EndpointProducerBuilder {
default AdvancedEtcdEndpointProducerBuilder advanced() {
return (AdvancedEtcdEndpointProducerBuilder) this;
}
/**
* To apply an action recursively.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default EtcdEndpointProducerBuilder recursive(boolean recursive) {
setProperty("recursive", recursive);
return this;
}
/**
* To apply an action recursively.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default EtcdEndpointProducerBuilder recursive(String recursive) {
setProperty("recursive", recursive);
return this;
}
/**
* The path to look for for service discovery.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default EtcdEndpointProducerBuilder servicePath(String servicePath) {
setProperty("servicePath", servicePath);
return this;
}
/**
* To set the maximum time an action could take to complete.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: common
*/
default EtcdEndpointProducerBuilder timeout(Long timeout) {
setProperty("timeout", timeout);
return this;
}
/**
* To set the maximum time an action could take to complete.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: common
*/
default EtcdEndpointProducerBuilder timeout(String timeout) {
setProperty("timeout", timeout);
return this;
}
/**
* To set the URIs the client connects.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default EtcdEndpointProducerBuilder uris(String uris) {
setProperty("uris", uris);
return this;
}
/**
* 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.
*
* Group: producer
*/
default EtcdEndpointProducerBuilder lazyStartProducer(
boolean lazyStartProducer) {
setProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* 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.
*
* Group: producer
*/
default EtcdEndpointProducerBuilder lazyStartProducer(
String lazyStartProducer) {
setProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* To set the lifespan of a key in milliseconds.
*
* The option is a: <code>java.lang.Integer</code> type.
*
* Group: producer
*/
default EtcdEndpointProducerBuilder timeToLive(Integer timeToLive) {
setProperty("timeToLive", timeToLive);
return this;
}
/**
* To set the lifespan of a key in milliseconds.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
*
* Group: producer
*/
default EtcdEndpointProducerBuilder timeToLive(String timeToLive) {
setProperty("timeToLive", timeToLive);
return this;
}
/**
* The password to use for basic authentication.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: security
*/
default EtcdEndpointProducerBuilder password(String password) {
setProperty("password", password);
return this;
}
/**
* To configure security using SSLContextParameters.
*
* The option is a:
* <code>org.apache.camel.support.jsse.SSLContextParameters</code> type.
*
* Group: security
*/
default EtcdEndpointProducerBuilder sslContextParameters(
Object sslContextParameters) {
setProperty("sslContextParameters", sslContextParameters);
return this;
}
/**
* To configure security using SSLContextParameters.
*
* The option will be converted to a
* <code>org.apache.camel.support.jsse.SSLContextParameters</code> type.
*
* Group: security
*/
default EtcdEndpointProducerBuilder sslContextParameters(
String sslContextParameters) {
setProperty("sslContextParameters", sslContextParameters);
return this;
}
/**
* The user name to use for basic authentication.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: security
*/
default EtcdEndpointProducerBuilder userName(String userName) {
setProperty("userName", userName);
return this;
}
}
/**
* Advanced builder for endpoint producers for the etcd component.
*/
public interface AdvancedEtcdEndpointProducerBuilder
extends
EndpointProducerBuilder {
default EtcdEndpointProducerBuilder basic() {
return (EtcdEndpointProducerBuilder) this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointProducerBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
setProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointProducerBuilder basicPropertyBinding(
String basicPropertyBinding) {
setProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointProducerBuilder synchronous(
boolean synchronous) {
setProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointProducerBuilder synchronous(
String synchronous) {
setProperty("synchronous", synchronous);
return this;
}
}
/**
* Builder for endpoint for the etcd component.
*/
public interface EtcdEndpointBuilder
extends
EtcdEndpointConsumerBuilder, EtcdEndpointProducerBuilder {
default AdvancedEtcdEndpointBuilder advanced() {
return (AdvancedEtcdEndpointBuilder) this;
}
/**
* To apply an action recursively.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default EtcdEndpointBuilder recursive(boolean recursive) {
setProperty("recursive", recursive);
return this;
}
/**
* To apply an action recursively.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default EtcdEndpointBuilder recursive(String recursive) {
setProperty("recursive", recursive);
return this;
}
/**
* The path to look for for service discovery.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default EtcdEndpointBuilder servicePath(String servicePath) {
setProperty("servicePath", servicePath);
return this;
}
/**
* To set the maximum time an action could take to complete.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: common
*/
default EtcdEndpointBuilder timeout(Long timeout) {
setProperty("timeout", timeout);
return this;
}
/**
* To set the maximum time an action could take to complete.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: common
*/
default EtcdEndpointBuilder timeout(String timeout) {
setProperty("timeout", timeout);
return this;
}
/**
* To set the URIs the client connects.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default EtcdEndpointBuilder uris(String uris) {
setProperty("uris", uris);
return this;
}
/**
* The password to use for basic authentication.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: security
*/
default EtcdEndpointBuilder password(String password) {
setProperty("password", password);
return this;
}
/**
* To configure security using SSLContextParameters.
*
* The option is a:
* <code>org.apache.camel.support.jsse.SSLContextParameters</code> type.
*
* Group: security
*/
default EtcdEndpointBuilder sslContextParameters(
Object sslContextParameters) {
setProperty("sslContextParameters", sslContextParameters);
return this;
}
/**
* To configure security using SSLContextParameters.
*
* The option will be converted to a
* <code>org.apache.camel.support.jsse.SSLContextParameters</code> type.
*
* Group: security
*/
default EtcdEndpointBuilder sslContextParameters(
String sslContextParameters) {
setProperty("sslContextParameters", sslContextParameters);
return this;
}
/**
* The user name to use for basic authentication.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: security
*/
default EtcdEndpointBuilder userName(String userName) {
setProperty("userName", userName);
return this;
}
}
/**
* Advanced builder for endpoint for the etcd component.
*/
public interface AdvancedEtcdEndpointBuilder
extends
AdvancedEtcdEndpointConsumerBuilder, AdvancedEtcdEndpointProducerBuilder {
default EtcdEndpointBuilder basic() {
return (EtcdEndpointBuilder) this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
setProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointBuilder basicPropertyBinding(
String basicPropertyBinding) {
setProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointBuilder synchronous(boolean synchronous) {
setProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedEtcdEndpointBuilder synchronous(String synchronous) {
setProperty("synchronous", synchronous);
return this;
}
}
/**
* etcd (camel-etcd)
* The camel etcd component allows you to work with Etcd, a distributed
* reliable key-value store.
*
* Category: clustering,database
* Available as of version: 2.18
* Maven coordinates: org.apache.camel:camel-etcd
*
* Syntax: <code>etcd:namespace/path</code>
*
* Path parameter: namespace (required)
* The API namespace to use
* The value can be one of: keys, stats, watch
*
* Path parameter: path
* The path the endpoint refers to
*/
default EtcdEndpointBuilder etcd(String path) {
class EtcdEndpointBuilderImpl extends AbstractEndpointBuilder implements EtcdEndpointBuilder, AdvancedEtcdEndpointBuilder {
public EtcdEndpointBuilderImpl(String path) {
super("etcd", path);
}
}
return new EtcdEndpointBuilderImpl(path);
}
}