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 2020/02/27 17:27:42 UTC
[camel] 03/13: CAMEL-14520 - Create an AWS-Kinesis component based
on SDK v2, regen docs
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 00301e546547ef2f015ca671265bae492b66a5bc
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Feb 27 16:09:44 2020 +0100
CAMEL-14520 - Create an AWS-Kinesis component based on SDK v2, regen docs
---
.../src/main/docs/aws2-kinesis-component.adoc | 17 ++++++++---------
.../src/main/docs/aws2-kinesis-firehose-component.adoc | 13 ++++++-------
2 files changed, 14 insertions(+), 16 deletions(-)
diff --git a/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc b/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
index c673f33..c24e4bb 100644
--- a/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
+++ b/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
@@ -1,5 +1,4 @@
-[[aws2-kinesis-component]]
-= AWS2 Kinesis Component
+= AWS 2 Kinesis Component
// HEADER START
*Both producer and consumer is supported*
@@ -29,7 +28,7 @@ The stream needs to be created prior to it being used. +
// component options: START
-The AWS Kinesis component supports 7 options, which are listed below.
+The AWS 2 Kinesis component supports 7 options, which are listed below.
@@ -42,7 +41,7 @@ The AWS Kinesis component supports 7 options, which are listed below.
| *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
| *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 [...]
| *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
-| *configuration* (advanced) | The AWS S3 default configuration | | KinesisConfiguration
+| *configuration* (advanced) | The AWS S3 default configuration | | Kinesis2Configuration
|===
// component options: END
@@ -53,10 +52,10 @@ The AWS Kinesis component supports 7 options, which are listed below.
// endpoint options: START
-The AWS Kinesis endpoint is configured using URI syntax:
+The AWS 2 Kinesis endpoint is configured using URI syntax:
----
-aws-kinesis:streamName
+aws2-kinesis:streamName
----
with the following path and query parameters:
@@ -77,17 +76,17 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *amazonKinesisClient* (common) | Amazon Kinesis client to use for all requests for this endpoint | | AmazonKinesis
+| *amazonKinesisClient* (common) | Amazon Kinesis client to use for all requests for this endpoint | | KinesisClient
| *proxyHost* (common) | To define a proxy host when instantiating the Kinesis client | | String
| *proxyPort* (common) | To define a proxy port when instantiating the Kinesis client | | Integer
| *proxyProtocol* (common) | To define a proxy protocol when instantiating the Kinesis client. The value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *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. The value can be one of: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP | TRIM_HORIZON | ShardIteratorType
+| *iteratorType* (consumer) | Defines where in the Kinesis stream to start getting records. The value can be one of: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP, null | TRIM_HORIZON | ShardIteratorType
| *maxResultsPerRequest* (consumer) | Maximum number of records that will be fetched in each poll | 1 | int
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean
| *sequenceNumber* (consumer) | The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER | | String
-| *shardClosed* (consumer) | 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 value can be one of: ignore, fail, silent | ignore | KinesisShardClosedStrategyEnum
+| *shardClosed* (consumer) | 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 value can be one of: ignore, fail, silent | ignore | Kinesis2ShardClosedStrategyEnum
| *shardId* (consumer) | Defines which shardId in the Kinesis stream to get records from | | String
| *exceptionHandler* (consumer) | 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. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern
diff --git a/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc b/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc
index 14e0554..fe0a261 100644
--- a/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc
+++ b/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc
@@ -1,5 +1,4 @@
-[[aws2-kinesis-firehose-component]]
-= AWS2 Kinesis Firehose Component
+= AWS 2 Kinesis Firehose Component
// HEADER START
*Only producer is supported*
@@ -28,7 +27,7 @@ The stream needs to be created prior to it being used. +
// component options: START
-The AWS Kinesis Firehose component supports 6 options, which are listed below.
+The AWS 2 Kinesis Firehose component supports 6 options, which are listed below.
@@ -40,7 +39,7 @@ The AWS Kinesis Firehose component supports 6 options, which are listed below.
| *region* (producer) | Amazon AWS Region | | String
| *secretKey* (producer) | Amazon AWS Secret Key | | String
| *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
-| *configuration* (advanced) | The AWS Kinesis Firehose default configuration | | KinesisFirehoseConfiguration
+| *configuration* (advanced) | The AWS Kinesis Firehose default configuration | | KinesisFirehose2Configuration
|===
// component options: END
@@ -51,10 +50,10 @@ The AWS Kinesis Firehose component supports 6 options, which are listed below.
// endpoint options: START
-The AWS Kinesis Firehose endpoint is configured using URI syntax:
+The AWS 2 Kinesis Firehose endpoint is configured using URI syntax:
----
-aws-kinesis-firehose:streamName
+aws2-kinesis-firehose:streamName
----
with the following path and query parameters:
@@ -75,7 +74,7 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *amazonKinesisFirehoseClient* (producer) | Amazon Kinesis Firehose client to use for all requests for this endpoint | | AmazonKinesisFirehose
+| *amazonKinesisFirehoseClient* (producer) | Amazon Kinesis Firehose client to use for all requests for this endpoint | | FirehoseClient
| *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 Kinesis Firehose client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the Kinesis Firehose client | | Integer