| /* |
| * 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; |
| |
| /** |
| * The aws-kinesis component is for consuming and producing records from Amazon |
| * Kinesis Streams. |
| * |
| * Generated by camel-package-maven-plugin - do not edit this file! |
| */ |
| @Generated("org.apache.camel.maven.packaging.EndpointDslMojo") |
| public interface KinesisEndpointBuilderFactory { |
| |
| |
| /** |
| * Builder for endpoint consumers for the AWS Kinesis component. |
| */ |
| public interface KinesisEndpointConsumerBuilder |
| extends |
| EndpointConsumerBuilder { |
| default AdvancedKinesisEndpointConsumerBuilder advanced() { |
| return (AdvancedKinesisEndpointConsumerBuilder) this; |
| } |
| /** |
| * Amazon Kinesis client to use for all requests for this endpoint. |
| * |
| * The option is a: |
| * <code>com.amazonaws.services.kinesis.AmazonKinesis</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointConsumerBuilder amazonKinesisClient( |
| Object amazonKinesisClient) { |
| doSetProperty("amazonKinesisClient", amazonKinesisClient); |
| return this; |
| } |
| /** |
| * Amazon Kinesis client to use for all requests for this endpoint. |
| * |
| * The option will be converted to a |
| * <code>com.amazonaws.services.kinesis.AmazonKinesis</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointConsumerBuilder amazonKinesisClient( |
| String amazonKinesisClient) { |
| doSetProperty("amazonKinesisClient", amazonKinesisClient); |
| return this; |
| } |
| /** |
| * To define a proxy host when instantiating the Kinesis client. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointConsumerBuilder proxyHost(String proxyHost) { |
| doSetProperty("proxyHost", proxyHost); |
| return this; |
| } |
| /** |
| * To define a proxy port when instantiating the Kinesis client. |
| * |
| * The option is a: <code>java.lang.Integer</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointConsumerBuilder proxyPort(Integer proxyPort) { |
| doSetProperty("proxyPort", proxyPort); |
| return this; |
| } |
| /** |
| * To define a proxy port when instantiating the Kinesis client. |
| * |
| * The option will be converted to a <code>java.lang.Integer</code> |
| * type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointConsumerBuilder proxyPort(String proxyPort) { |
| doSetProperty("proxyPort", proxyPort); |
| return this; |
| } |
| /** |
| * To define a proxy protocol when instantiating the Kinesis client. |
| * |
| * The option is a: <code>com.amazonaws.Protocol</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointConsumerBuilder proxyProtocol( |
| Protocol proxyProtocol) { |
| doSetProperty("proxyProtocol", proxyProtocol); |
| return this; |
| } |
| /** |
| * To define a proxy protocol when instantiating the Kinesis client. |
| * |
| * The option will be converted to a <code>com.amazonaws.Protocol</code> |
| * type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointConsumerBuilder proxyProtocol( |
| String proxyProtocol) { |
| doSetProperty("proxyProtocol", proxyProtocol); |
| return this; |
| } |
| /** |
| * The region in which Kinesis client needs to work. When using this |
| * parameter, the configuration will expect the capitalized name of the |
| * region (for example AP_EAST_1)You'll need to use the name |
| * Regions.EU_WEST_1.name(). |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointConsumerBuilder region(String region) { |
| doSetProperty("region", region); |
| 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 KinesisEndpointConsumerBuilder bridgeErrorHandler( |
| boolean bridgeErrorHandler) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder bridgeErrorHandler( |
| String bridgeErrorHandler) { |
| doSetProperty("bridgeErrorHandler", bridgeErrorHandler); |
| return this; |
| } |
| /** |
| * Defines where in the Kinesis stream to start getting records. |
| * |
| * The option is a: |
| * <code>com.amazonaws.services.kinesis.model.ShardIteratorType</code> |
| * type. |
| * |
| * Group: consumer |
| */ |
| default KinesisEndpointConsumerBuilder iteratorType( |
| ShardIteratorType iteratorType) { |
| doSetProperty("iteratorType", iteratorType); |
| return this; |
| } |
| /** |
| * Defines where in the Kinesis stream to start getting records. |
| * |
| * The option will be converted to a |
| * <code>com.amazonaws.services.kinesis.model.ShardIteratorType</code> |
| * type. |
| * |
| * Group: consumer |
| */ |
| default KinesisEndpointConsumerBuilder iteratorType(String iteratorType) { |
| doSetProperty("iteratorType", iteratorType); |
| return this; |
| } |
| /** |
| * Maximum number of records that will be fetched in each poll. |
| * |
| * The option is a: <code>int</code> type. |
| * |
| * Group: consumer |
| */ |
| default KinesisEndpointConsumerBuilder maxResultsPerRequest( |
| int maxResultsPerRequest) { |
| doSetProperty("maxResultsPerRequest", maxResultsPerRequest); |
| return this; |
| } |
| /** |
| * Maximum number of records that will be fetched in each poll. |
| * |
| * The option will be converted to a <code>int</code> type. |
| * |
| * Group: consumer |
| */ |
| default KinesisEndpointConsumerBuilder maxResultsPerRequest( |
| String maxResultsPerRequest) { |
| doSetProperty("maxResultsPerRequest", maxResultsPerRequest); |
| 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 KinesisEndpointConsumerBuilder sendEmptyMessageWhenIdle( |
| boolean sendEmptyMessageWhenIdle) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder sendEmptyMessageWhenIdle( |
| String sendEmptyMessageWhenIdle) { |
| doSetProperty("sendEmptyMessageWhenIdle", sendEmptyMessageWhenIdle); |
| return this; |
| } |
| /** |
| * The sequence number to start polling from. Required if iteratorType |
| * is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: consumer |
| */ |
| default KinesisEndpointConsumerBuilder sequenceNumber( |
| String sequenceNumber) { |
| doSetProperty("sequenceNumber", sequenceNumber); |
| return this; |
| } |
| /** |
| * Define what will be the behavior in case of shard closed. Possible |
| * value are ignore, silent and fail. In case of ignore a message will |
| * be logged and the consumer will restart from the beginning,in case of |
| * silent there will be no logging and the consumer will start from the |
| * beginning,in case of fail a ReachedClosedStateException will be |
| * raised. |
| * |
| * The option is a: |
| * <code>org.apache.camel.component.aws.kinesis.KinesisShardClosedStrategyEnum</code> type. |
| * |
| * Group: consumer |
| */ |
| default KinesisEndpointConsumerBuilder shardClosed( |
| KinesisShardClosedStrategyEnum shardClosed) { |
| doSetProperty("shardClosed", shardClosed); |
| return this; |
| } |
| /** |
| * Define what will be the behavior in case of shard closed. Possible |
| * value are ignore, silent and fail. In case of ignore a message will |
| * be logged and the consumer will restart from the beginning,in case of |
| * silent there will be no logging and the consumer will start from the |
| * beginning,in case of fail a ReachedClosedStateException will be |
| * raised. |
| * |
| * The option will be converted to a |
| * <code>org.apache.camel.component.aws.kinesis.KinesisShardClosedStrategyEnum</code> type. |
| * |
| * Group: consumer |
| */ |
| default KinesisEndpointConsumerBuilder shardClosed(String shardClosed) { |
| doSetProperty("shardClosed", shardClosed); |
| return this; |
| } |
| /** |
| * Defines which shardId in the Kinesis stream to get records from. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: consumer |
| */ |
| default KinesisEndpointConsumerBuilder shardId(String shardId) { |
| doSetProperty("shardId", shardId); |
| 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 KinesisEndpointConsumerBuilder backoffErrorThreshold( |
| int backoffErrorThreshold) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder backoffErrorThreshold( |
| String backoffErrorThreshold) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder backoffIdleThreshold( |
| int backoffIdleThreshold) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder backoffIdleThreshold( |
| String backoffIdleThreshold) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder backoffMultiplier( |
| int backoffMultiplier) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder backoffMultiplier( |
| String backoffMultiplier) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder delay(long delay) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder delay(String delay) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder greedy(boolean greedy) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder greedy(String greedy) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder initialDelay(long initialDelay) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder initialDelay(String initialDelay) { |
| doSetProperty("initialDelay", initialDelay); |
| return this; |
| } |
| /** |
| * Specifies a maximum limit of number of fires. So if you set it to 1, |
| * the scheduler will only fire once. If you set it to 5, it will only |
| * fire five times. A value of zero or negative means fire forever. |
| * |
| * The option is a: <code>long</code> type. |
| * |
| * Group: scheduler |
| */ |
| default KinesisEndpointConsumerBuilder repeatCount(long repeatCount) { |
| doSetProperty("repeatCount", repeatCount); |
| return this; |
| } |
| /** |
| * Specifies a maximum limit of number of fires. So if you set it to 1, |
| * the scheduler will only fire once. If you set it to 5, it will only |
| * fire five times. A value of zero or negative means fire forever. |
| * |
| * The option will be converted to a <code>long</code> type. |
| * |
| * Group: scheduler |
| */ |
| default KinesisEndpointConsumerBuilder repeatCount(String repeatCount) { |
| doSetProperty("repeatCount", repeatCount); |
| 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 KinesisEndpointConsumerBuilder runLoggingLevel( |
| LoggingLevel runLoggingLevel) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder runLoggingLevel( |
| String runLoggingLevel) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder scheduledExecutorService( |
| ScheduledExecutorService scheduledExecutorService) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder scheduledExecutorService( |
| String scheduledExecutorService) { |
| doSetProperty("scheduledExecutorService", scheduledExecutorService); |
| return this; |
| } |
| /** |
| * To use a cron scheduler from either camel-spring or camel-quartz |
| * component. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: scheduler |
| */ |
| default KinesisEndpointConsumerBuilder scheduler(String scheduler) { |
| doSetProperty("scheduler", scheduler); |
| return this; |
| } |
| /** |
| * To configure additional properties when using a custom scheduler or |
| * any of the Quartz, Spring based scheduler. |
| * |
| * The option is a: <code>java.util.Map<java.lang.String, |
| * java.lang.Object></code> type. |
| * |
| * Group: scheduler |
| */ |
| default KinesisEndpointConsumerBuilder schedulerProperties( |
| Map<String, Object> schedulerProperties) { |
| doSetProperty("schedulerProperties", schedulerProperties); |
| return this; |
| } |
| /** |
| * To configure additional properties when using a custom scheduler or |
| * any of the Quartz, Spring based scheduler. |
| * |
| * The option will be converted to a |
| * <code>java.util.Map<java.lang.String, java.lang.Object></code> |
| * type. |
| * |
| * Group: scheduler |
| */ |
| default KinesisEndpointConsumerBuilder schedulerProperties( |
| String schedulerProperties) { |
| doSetProperty("schedulerProperties", schedulerProperties); |
| return this; |
| } |
| /** |
| * Whether the scheduler should be auto started. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: scheduler |
| */ |
| default KinesisEndpointConsumerBuilder startScheduler( |
| boolean startScheduler) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder startScheduler( |
| String startScheduler) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder timeUnit(TimeUnit timeUnit) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder timeUnit(String timeUnit) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder useFixedDelay( |
| boolean useFixedDelay) { |
| doSetProperty("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 KinesisEndpointConsumerBuilder useFixedDelay( |
| String useFixedDelay) { |
| doSetProperty("useFixedDelay", useFixedDelay); |
| return this; |
| } |
| /** |
| * Amazon AWS Access Key. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: security |
| */ |
| default KinesisEndpointConsumerBuilder accessKey(String accessKey) { |
| doSetProperty("accessKey", accessKey); |
| return this; |
| } |
| /** |
| * Amazon AWS Secret Key. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: security |
| */ |
| default KinesisEndpointConsumerBuilder secretKey(String secretKey) { |
| doSetProperty("secretKey", secretKey); |
| return this; |
| } |
| } |
| |
| /** |
| * Advanced builder for endpoint consumers for the AWS Kinesis component. |
| */ |
| public interface AdvancedKinesisEndpointConsumerBuilder |
| extends |
| EndpointConsumerBuilder { |
| default KinesisEndpointConsumerBuilder basic() { |
| return (KinesisEndpointConsumerBuilder) 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 AdvancedKinesisEndpointConsumerBuilder exceptionHandler( |
| ExceptionHandler exceptionHandler) { |
| doSetProperty("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 AdvancedKinesisEndpointConsumerBuilder exceptionHandler( |
| String exceptionHandler) { |
| doSetProperty("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 AdvancedKinesisEndpointConsumerBuilder exchangePattern( |
| ExchangePattern exchangePattern) { |
| doSetProperty("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 AdvancedKinesisEndpointConsumerBuilder exchangePattern( |
| String exchangePattern) { |
| doSetProperty("exchangePattern", exchangePattern); |
| 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 AdvancedKinesisEndpointConsumerBuilder pollStrategy( |
| PollingConsumerPollStrategy pollStrategy) { |
| doSetProperty("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 AdvancedKinesisEndpointConsumerBuilder pollStrategy( |
| String pollStrategy) { |
| doSetProperty("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 AdvancedKinesisEndpointConsumerBuilder basicPropertyBinding( |
| boolean basicPropertyBinding) { |
| doSetProperty("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 AdvancedKinesisEndpointConsumerBuilder basicPropertyBinding( |
| String basicPropertyBinding) { |
| doSetProperty("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 AdvancedKinesisEndpointConsumerBuilder synchronous( |
| boolean synchronous) { |
| doSetProperty("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 AdvancedKinesisEndpointConsumerBuilder synchronous( |
| String synchronous) { |
| doSetProperty("synchronous", synchronous); |
| return this; |
| } |
| } |
| |
| /** |
| * Builder for endpoint producers for the AWS Kinesis component. |
| */ |
| public interface KinesisEndpointProducerBuilder |
| extends |
| EndpointProducerBuilder { |
| default AdvancedKinesisEndpointProducerBuilder advanced() { |
| return (AdvancedKinesisEndpointProducerBuilder) this; |
| } |
| /** |
| * Amazon Kinesis client to use for all requests for this endpoint. |
| * |
| * The option is a: |
| * <code>com.amazonaws.services.kinesis.AmazonKinesis</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointProducerBuilder amazonKinesisClient( |
| Object amazonKinesisClient) { |
| doSetProperty("amazonKinesisClient", amazonKinesisClient); |
| return this; |
| } |
| /** |
| * Amazon Kinesis client to use for all requests for this endpoint. |
| * |
| * The option will be converted to a |
| * <code>com.amazonaws.services.kinesis.AmazonKinesis</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointProducerBuilder amazonKinesisClient( |
| String amazonKinesisClient) { |
| doSetProperty("amazonKinesisClient", amazonKinesisClient); |
| return this; |
| } |
| /** |
| * To define a proxy host when instantiating the Kinesis client. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointProducerBuilder proxyHost(String proxyHost) { |
| doSetProperty("proxyHost", proxyHost); |
| return this; |
| } |
| /** |
| * To define a proxy port when instantiating the Kinesis client. |
| * |
| * The option is a: <code>java.lang.Integer</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointProducerBuilder proxyPort(Integer proxyPort) { |
| doSetProperty("proxyPort", proxyPort); |
| return this; |
| } |
| /** |
| * To define a proxy port when instantiating the Kinesis client. |
| * |
| * The option will be converted to a <code>java.lang.Integer</code> |
| * type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointProducerBuilder proxyPort(String proxyPort) { |
| doSetProperty("proxyPort", proxyPort); |
| return this; |
| } |
| /** |
| * To define a proxy protocol when instantiating the Kinesis client. |
| * |
| * The option is a: <code>com.amazonaws.Protocol</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointProducerBuilder proxyProtocol( |
| Protocol proxyProtocol) { |
| doSetProperty("proxyProtocol", proxyProtocol); |
| return this; |
| } |
| /** |
| * To define a proxy protocol when instantiating the Kinesis client. |
| * |
| * The option will be converted to a <code>com.amazonaws.Protocol</code> |
| * type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointProducerBuilder proxyProtocol( |
| String proxyProtocol) { |
| doSetProperty("proxyProtocol", proxyProtocol); |
| return this; |
| } |
| /** |
| * The region in which Kinesis client needs to work. When using this |
| * parameter, the configuration will expect the capitalized name of the |
| * region (for example AP_EAST_1)You'll need to use the name |
| * Regions.EU_WEST_1.name(). |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointProducerBuilder region(String region) { |
| doSetProperty("region", region); |
| 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 KinesisEndpointProducerBuilder lazyStartProducer( |
| boolean lazyStartProducer) { |
| doSetProperty("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 KinesisEndpointProducerBuilder lazyStartProducer( |
| String lazyStartProducer) { |
| doSetProperty("lazyStartProducer", lazyStartProducer); |
| return this; |
| } |
| /** |
| * Amazon AWS Access Key. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: security |
| */ |
| default KinesisEndpointProducerBuilder accessKey(String accessKey) { |
| doSetProperty("accessKey", accessKey); |
| return this; |
| } |
| /** |
| * Amazon AWS Secret Key. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: security |
| */ |
| default KinesisEndpointProducerBuilder secretKey(String secretKey) { |
| doSetProperty("secretKey", secretKey); |
| return this; |
| } |
| } |
| |
| /** |
| * Advanced builder for endpoint producers for the AWS Kinesis component. |
| */ |
| public interface AdvancedKinesisEndpointProducerBuilder |
| extends |
| EndpointProducerBuilder { |
| default KinesisEndpointProducerBuilder basic() { |
| return (KinesisEndpointProducerBuilder) 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 AdvancedKinesisEndpointProducerBuilder basicPropertyBinding( |
| boolean basicPropertyBinding) { |
| doSetProperty("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 AdvancedKinesisEndpointProducerBuilder basicPropertyBinding( |
| String basicPropertyBinding) { |
| doSetProperty("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 AdvancedKinesisEndpointProducerBuilder synchronous( |
| boolean synchronous) { |
| doSetProperty("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 AdvancedKinesisEndpointProducerBuilder synchronous( |
| String synchronous) { |
| doSetProperty("synchronous", synchronous); |
| return this; |
| } |
| } |
| |
| /** |
| * Builder for endpoint for the AWS Kinesis component. |
| */ |
| public interface KinesisEndpointBuilder |
| extends |
| KinesisEndpointConsumerBuilder, KinesisEndpointProducerBuilder { |
| default AdvancedKinesisEndpointBuilder advanced() { |
| return (AdvancedKinesisEndpointBuilder) this; |
| } |
| /** |
| * Amazon Kinesis client to use for all requests for this endpoint. |
| * |
| * The option is a: |
| * <code>com.amazonaws.services.kinesis.AmazonKinesis</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointBuilder amazonKinesisClient( |
| Object amazonKinesisClient) { |
| doSetProperty("amazonKinesisClient", amazonKinesisClient); |
| return this; |
| } |
| /** |
| * Amazon Kinesis client to use for all requests for this endpoint. |
| * |
| * The option will be converted to a |
| * <code>com.amazonaws.services.kinesis.AmazonKinesis</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointBuilder amazonKinesisClient( |
| String amazonKinesisClient) { |
| doSetProperty("amazonKinesisClient", amazonKinesisClient); |
| return this; |
| } |
| /** |
| * To define a proxy host when instantiating the Kinesis client. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointBuilder proxyHost(String proxyHost) { |
| doSetProperty("proxyHost", proxyHost); |
| return this; |
| } |
| /** |
| * To define a proxy port when instantiating the Kinesis client. |
| * |
| * The option is a: <code>java.lang.Integer</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointBuilder proxyPort(Integer proxyPort) { |
| doSetProperty("proxyPort", proxyPort); |
| return this; |
| } |
| /** |
| * To define a proxy port when instantiating the Kinesis client. |
| * |
| * The option will be converted to a <code>java.lang.Integer</code> |
| * type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointBuilder proxyPort(String proxyPort) { |
| doSetProperty("proxyPort", proxyPort); |
| return this; |
| } |
| /** |
| * To define a proxy protocol when instantiating the Kinesis client. |
| * |
| * The option is a: <code>com.amazonaws.Protocol</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointBuilder proxyProtocol(Protocol proxyProtocol) { |
| doSetProperty("proxyProtocol", proxyProtocol); |
| return this; |
| } |
| /** |
| * To define a proxy protocol when instantiating the Kinesis client. |
| * |
| * The option will be converted to a <code>com.amazonaws.Protocol</code> |
| * type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointBuilder proxyProtocol(String proxyProtocol) { |
| doSetProperty("proxyProtocol", proxyProtocol); |
| return this; |
| } |
| /** |
| * The region in which Kinesis client needs to work. When using this |
| * parameter, the configuration will expect the capitalized name of the |
| * region (for example AP_EAST_1)You'll need to use the name |
| * Regions.EU_WEST_1.name(). |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: common |
| */ |
| default KinesisEndpointBuilder region(String region) { |
| doSetProperty("region", region); |
| return this; |
| } |
| /** |
| * Amazon AWS Access Key. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: security |
| */ |
| default KinesisEndpointBuilder accessKey(String accessKey) { |
| doSetProperty("accessKey", accessKey); |
| return this; |
| } |
| /** |
| * Amazon AWS Secret Key. |
| * |
| * The option is a: <code>java.lang.String</code> type. |
| * |
| * Group: security |
| */ |
| default KinesisEndpointBuilder secretKey(String secretKey) { |
| doSetProperty("secretKey", secretKey); |
| return this; |
| } |
| } |
| |
| /** |
| * Advanced builder for endpoint for the AWS Kinesis component. |
| */ |
| public interface AdvancedKinesisEndpointBuilder |
| extends |
| AdvancedKinesisEndpointConsumerBuilder, AdvancedKinesisEndpointProducerBuilder { |
| default KinesisEndpointBuilder basic() { |
| return (KinesisEndpointBuilder) 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 AdvancedKinesisEndpointBuilder basicPropertyBinding( |
| boolean basicPropertyBinding) { |
| doSetProperty("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 AdvancedKinesisEndpointBuilder basicPropertyBinding( |
| String basicPropertyBinding) { |
| doSetProperty("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 AdvancedKinesisEndpointBuilder synchronous(boolean synchronous) { |
| doSetProperty("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 AdvancedKinesisEndpointBuilder synchronous(String synchronous) { |
| doSetProperty("synchronous", synchronous); |
| return this; |
| } |
| } |
| |
| /** |
| * Proxy enum for <code>com.amazonaws.Protocol</code> enum. |
| */ |
| enum Protocol { |
| http, |
| https; |
| } |
| |
| /** |
| * Proxy enum for |
| * <code>com.amazonaws.services.kinesis.model.ShardIteratorType</code> enum. |
| */ |
| enum ShardIteratorType { |
| AT_SEQUENCE_NUMBER, |
| AFTER_SEQUENCE_NUMBER, |
| TRIM_HORIZON, |
| LATEST, |
| AT_TIMESTAMP; |
| } |
| |
| /** |
| * Proxy enum for |
| * <code>org.apache.camel.component.aws.kinesis.KinesisShardClosedStrategyEnum</code> enum. |
| */ |
| enum KinesisShardClosedStrategyEnum { |
| ignore, |
| fail, |
| silent; |
| } |
| /** |
| * AWS Kinesis (camel-aws-kinesis) |
| * The aws-kinesis component is for consuming and producing records from |
| * Amazon Kinesis Streams. |
| * |
| * Category: cloud,messaging |
| * Since: 2.17 |
| * Maven coordinates: org.apache.camel:camel-aws-kinesis |
| * |
| * Syntax: <code>aws-kinesis:streamName</code> |
| * |
| * Path parameter: streamName (required) |
| * Name of the stream |
| */ |
| default KinesisEndpointBuilder awsKinesis(String path) { |
| class KinesisEndpointBuilderImpl extends AbstractEndpointBuilder implements KinesisEndpointBuilder, AdvancedKinesisEndpointBuilder { |
| public KinesisEndpointBuilderImpl(String path) { |
| super("aws-kinesis", path); |
| } |
| } |
| return new KinesisEndpointBuilderImpl(path); |
| } |
| } |