You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2019/07/05 10:52:01 UTC
[camel] 07/18: CAMEL-13723 - Better docs, Kinesis
This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 7f95bb21e6d1b44056cf7325abd01c6fabb21465
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Fri Jul 5 12:24:11 2019 +0200
CAMEL-13723 - Better docs, Kinesis
---
.../src/main/docs/aws-kinesis-component.adoc | 2 +-
.../src/main/docs/aws-kinesis-firehose-component.adoc | 2 +-
.../aws/firehose/KinesisFirehoseConfiguration.java | 3 ++-
.../camel/component/aws/kinesis/KinesisConfiguration.java | 3 ++-
.../endpoint/dsl/KinesisEndpointBuilderFactory.java | 15 ++++++++++++---
.../dsl/KinesisFirehoseEndpointBuilderFactory.java | 5 ++++-
.../springboot/KinesisFirehoseComponentConfiguration.java | 5 ++++-
.../kinesis/springboot/KinesisComponentConfiguration.java | 5 ++++-
8 files changed, 30 insertions(+), 10 deletions(-)
diff --git a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc
index 09ba7e2..1b0b613 100644
--- a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc
+++ b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc
@@ -77,7 +77,7 @@ with the following path and query parameters:
| *amazonKinesisClient* (common) | Amazon Kinesis client to use for all requests for this endpoint | | AmazonKinesis
| *proxyHost* (common) | To define a proxy host when instantiating the DDBStreams client | | String
| *proxyPort* (common) | To define a proxy port when instantiating the DDBStreams client | | Integer
-| *region* (common) | The region in which Kinesis client needs to work | | String
+| *region* (common) | 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() | | String
| *bridgeErrorHandler* (consumer) | 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. | false | boolean
| *iteratorType* (consumer) | Defines where in the Kinesis stream to start getting records | TRIM_HORIZON | ShardIteratorType
| *maxResultsPerRequest* (consumer) | Maximum number of records that will be fetched in each poll | 1 | int
diff --git a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc
index 9224621..94ed93d 100644
--- a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc
+++ b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc
@@ -77,7 +77,7 @@ with the following path and query parameters:
| *lazyStartProducer* (producer) | 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 [...]
| *proxyHost* (producer) | To define a proxy host when instantiating the DDBStreams client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the DDBStreams client | | Integer
-| *region* (producer) | The region in which Kinesis client needs to work | | String
+| *region* (producer) | 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() | | String
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
| *accessKey* (security) | Amazon AWS Access Key | | String
diff --git a/components/camel-aws-kinesis/src/main/java/org/apache/camel/component/aws/firehose/KinesisFirehoseConfiguration.java b/components/camel-aws-kinesis/src/main/java/org/apache/camel/component/aws/firehose/KinesisFirehoseConfiguration.java
index 8583ef7..6a5059c 100644
--- a/components/camel-aws-kinesis/src/main/java/org/apache/camel/component/aws/firehose/KinesisFirehoseConfiguration.java
+++ b/components/camel-aws-kinesis/src/main/java/org/apache/camel/component/aws/firehose/KinesisFirehoseConfiguration.java
@@ -34,7 +34,8 @@ public class KinesisFirehoseConfiguration implements Cloneable {
private String accessKey;
@UriParam(label = "security", secret = true, description = "Amazon AWS Secret Key")
private String secretKey;
- @UriParam(description = "The region in which Kinesis client needs to work")
+ @UriParam(description = "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()")
private String region;
@UriParam(description = "Amazon Kinesis Firehose client to use for all requests for this endpoint")
private AmazonKinesisFirehose amazonKinesisFirehoseClient;
diff --git a/components/camel-aws-kinesis/src/main/java/org/apache/camel/component/aws/kinesis/KinesisConfiguration.java b/components/camel-aws-kinesis/src/main/java/org/apache/camel/component/aws/kinesis/KinesisConfiguration.java
index d7c4c52..e9bef7f 100644
--- a/components/camel-aws-kinesis/src/main/java/org/apache/camel/component/aws/kinesis/KinesisConfiguration.java
+++ b/components/camel-aws-kinesis/src/main/java/org/apache/camel/component/aws/kinesis/KinesisConfiguration.java
@@ -35,7 +35,8 @@ public class KinesisConfiguration implements Cloneable {
private String accessKey;
@UriParam(label = "security", secret = true, description = "Amazon AWS Secret Key")
private String secretKey;
- @UriParam(description = "The region in which Kinesis client needs to work")
+ @UriParam(description = "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()")
private String region;
@UriParam(description = "Amazon Kinesis client to use for all requests for this endpoint")
private AmazonKinesis amazonKinesisClient;
diff --git a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/KinesisEndpointBuilderFactory.java b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/KinesisEndpointBuilderFactory.java
index af3841d..f77b82d 100644
--- a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/KinesisEndpointBuilderFactory.java
+++ b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/KinesisEndpointBuilderFactory.java
@@ -109,7 +109,10 @@ public interface KinesisEndpointBuilderFactory {
return this;
}
/**
- * The region in which Kinesis client needs to work.
+ * 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.
*
@@ -887,7 +890,10 @@ public interface KinesisEndpointBuilderFactory {
return this;
}
/**
- * The region in which Kinesis client needs to work.
+ * 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.
*
@@ -1094,7 +1100,10 @@ public interface KinesisEndpointBuilderFactory {
return this;
}
/**
- * The region in which Kinesis client needs to work.
+ * 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.
*
diff --git a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/KinesisFirehoseEndpointBuilderFactory.java b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/KinesisFirehoseEndpointBuilderFactory.java
index 4f9df65..b07c010 100644
--- a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/KinesisFirehoseEndpointBuilderFactory.java
+++ b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/KinesisFirehoseEndpointBuilderFactory.java
@@ -103,7 +103,10 @@ public interface KinesisFirehoseEndpointBuilderFactory {
return this;
}
/**
- * The region in which Kinesis client needs to work.
+ * 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.
*
diff --git a/platforms/spring-boot/components-starter/camel-aws-kinesis-starter/src/main/java/org/apache/camel/component/aws/firehose/springboot/KinesisFirehoseComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-kinesis-starter/src/main/java/org/apache/camel/component/aws/firehose/springboot/KinesisFirehoseComponentConfiguration.java
index fb1f93d..c39f3a7 100644
--- a/platforms/spring-boot/components-starter/camel-aws-kinesis-starter/src/main/java/org/apache/camel/component/aws/firehose/springboot/KinesisFirehoseComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-kinesis-starter/src/main/java/org/apache/camel/component/aws/firehose/springboot/KinesisFirehoseComponentConfiguration.java
@@ -136,7 +136,10 @@ public class KinesisFirehoseComponentConfiguration
*/
private String secretKey;
/**
- * The region in which Kinesis client needs to work
+ * 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()
*/
private String region;
/**
diff --git a/platforms/spring-boot/components-starter/camel-aws-kinesis-starter/src/main/java/org/apache/camel/component/aws/kinesis/springboot/KinesisComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-kinesis-starter/src/main/java/org/apache/camel/component/aws/kinesis/springboot/KinesisComponentConfiguration.java
index 72adbfd..63f1de5 100644
--- a/platforms/spring-boot/components-starter/camel-aws-kinesis-starter/src/main/java/org/apache/camel/component/aws/kinesis/springboot/KinesisComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-kinesis-starter/src/main/java/org/apache/camel/component/aws/kinesis/springboot/KinesisComponentConfiguration.java
@@ -163,7 +163,10 @@ public class KinesisComponentConfiguration
*/
private String secretKey;
/**
- * The region in which Kinesis client needs to work
+ * 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()
*/
private String region;
/**