This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit fd758117f8df95668bb6da18bc32b7f1f038b5e1
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Fri Feb 9 15:25:24 2024 +0100
(chores) camel-aws2-kinesis: documentation fixes
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../catalog/components/aws2-kinesis-firehose.json | 4 +--
.../camel/catalog/components/aws2-kinesis.json | 4 +--
.../aws2/firehose/aws2-kinesis-firehose.json | 4 +--
.../camel/component/aws2/kinesis/aws2-kinesis.json | 4 +--
.../src/main/docs/aws2-kinesis-component.adoc | 30 ++++++++++++----------
.../main/docs/aws2-kinesis-firehose-component.adoc | 20 ++++++++-------
.../firehose/KinesisFirehose2Configuration.java | 2 +-
.../aws2/kinesis/Kinesis2Configuration.java | 2 +-
8 files changed, 37 insertions(+), 33 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-kinesis-firehose.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-kinesis-firehose.json
index 151568f0165..8284a2e1f8d 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-kinesis-firehose.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-kinesis-firehose.json
@@ -25,7 +25,7 @@
"componentProperties": {
"cborEnabled": { "index": 0, "kind": "property", "displayName": "Cbor
Enabled", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "This option will set the
CBOR_ENABLED property during the execution" },
"configuration": { "index": 1, "kind": "property", "displayName":
"Configuration", "group": "producer", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"deprecated": false, "autowired": false, "secret": false, "description":
"Component configuration" },
- "overrideEndpoint": { "index": 2, "kind": "property", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be u [...]
+ "overrideEndpoint": { "index": 2, "kind": "property", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be u [...]
"lazyStartProducer": { "index": 3, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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 [...]
"operation": { "index": 4, "kind": "property", "displayName": "Operation",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations", "enum":
[ "sendBatchRecord", "createDeliveryStream", "deleteDeliveryStream",
"describeDeliveryStream", "updateDestination" ], "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.Kin [...]
"region": { "index": 5, "kind": "property", "displayName": "Region",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "us-west-1",
"us-west-2", "af-south-1", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1",
"ap-northeast-3", "ap-northeast-2", "ap-nor [...]
@@ -52,7 +52,7 @@
"properties": {
"streamName": { "index": 0, "kind": "path", "displayName": "Stream Name",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Name of the stream" },
"cborEnabled": { "index": 1, "kind": "parameter", "displayName": "Cbor
Enabled", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "This option will set the
CBOR_ENABLED property during the execution" },
- "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be [...]
+ "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be [...]
"uriEndpointOverride": { "index": 3, "kind": "parameter", "displayName":
"Uri Endpoint Override", "group": "common", "label": "common", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combinati [...]
"operation": { "index": 4, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "producer", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations", "enum":
[ "sendBatchRecord", "createDeliveryStream", "deleteDeliveryStream",
"describeDeliveryStream", "updateDestination" ], "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.Ki [...]
"region": { "index": 5, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "us-west-1",
"us-west-2", "af-south-1", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1",
"ap-northeast-3", "ap-northeast-2", "ap-no [...]
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-kinesis.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-kinesis.json
index 9c12e15044c..7de14d632ad 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-kinesis.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-kinesis.json
@@ -25,7 +25,7 @@
"componentProperties": {
"cborEnabled": { "index": 0, "kind": "property", "displayName": "Cbor
Enabled", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "This option will set the
CBOR_ENABLED property during the execution" },
"configuration": { "index": 1, "kind": "property", "displayName":
"Configuration", "group": "common", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration", "deprecated":
false, "autowired": false, "secret": false, "description": "Component
configuration" },
- "overrideEndpoint": { "index": 2, "kind": "property", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in co [...]
+ "overrideEndpoint": { "index": 2, "kind": "property", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in co [...]
"region": { "index": 3, "kind": "property", "displayName": "Region",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "us-west-1",
"us-west-2", "af-south-1", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1",
"ap-northeast-3", "ap-northeast-2", "ap-north [...]
"uriEndpointOverride": { "index": 4, "kind": "property", "displayName":
"Uri Endpoint Override", "group": "common", "label": "common", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with ov [...]
"bridgeErrorHandler": { "index": 5, "kind": "property", "displayName":
"Bridge Error Handler", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Allows for bridging the consumer to the Camel routing Error Handler, which
mean any exceptions (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
@@ -62,7 +62,7 @@
"properties": {
"streamName": { "index": 0, "kind": "path", "displayName": "Stream Name",
"group": "common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Name of the stream" },
"cborEnabled": { "index": 1, "kind": "parameter", "displayName": "Cbor
Enabled", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "This option will set the
CBOR_ENABLED property during the execution" },
- "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in c [...]
+ "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in c [...]
"region": { "index": 3, "kind": "parameter", "displayName": "Region",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "us-west-1",
"us-west-2", "af-south-1", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1",
"ap-northeast-3", "ap-northeast-2", "ap-nort [...]
"uriEndpointOverride": { "index": 4, "kind": "parameter", "displayName":
"Uri Endpoint Override", "group": "common", "label": "common", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with o [...]
"iteratorType": { "index": 5, "kind": "parameter", "displayName":
"Iterator Type", "group": "consumer", "label": "consumer", "required": false,
"type": "object", "javaType":
"software.amazon.awssdk.services.kinesis.model.ShardIteratorType", "enum": [
"AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER", "TRIM_HORIZON", "LATEST",
"AT_TIMESTAMP", "null" ], "deprecated": false, "autowired": false, "secret":
false, "defaultValue": "TRIM_HORIZON", "configurationClass":
"org.apache.camel.componen [...]
diff --git
a/components/camel-aws/camel-aws2-kinesis/src/generated/resources/org/apache/camel/component/aws2/firehose/aws2-kinesis-firehose.json
b/components/camel-aws/camel-aws2-kinesis/src/generated/resources/org/apache/camel/component/aws2/firehose/aws2-kinesis-firehose.json
index 151568f0165..8284a2e1f8d 100644
---
a/components/camel-aws/camel-aws2-kinesis/src/generated/resources/org/apache/camel/component/aws2/firehose/aws2-kinesis-firehose.json
+++
b/components/camel-aws/camel-aws2-kinesis/src/generated/resources/org/apache/camel/component/aws2/firehose/aws2-kinesis-firehose.json
@@ -25,7 +25,7 @@
"componentProperties": {
"cborEnabled": { "index": 0, "kind": "property", "displayName": "Cbor
Enabled", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "This option will set the
CBOR_ENABLED property during the execution" },
"configuration": { "index": 1, "kind": "property", "displayName":
"Configuration", "group": "producer", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"deprecated": false, "autowired": false, "secret": false, "description":
"Component configuration" },
- "overrideEndpoint": { "index": 2, "kind": "property", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be u [...]
+ "overrideEndpoint": { "index": 2, "kind": "property", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be u [...]
"lazyStartProducer": { "index": 3, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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 [...]
"operation": { "index": 4, "kind": "property", "displayName": "Operation",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations", "enum":
[ "sendBatchRecord", "createDeliveryStream", "deleteDeliveryStream",
"describeDeliveryStream", "updateDestination" ], "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.Kin [...]
"region": { "index": 5, "kind": "property", "displayName": "Region",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "us-west-1",
"us-west-2", "af-south-1", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1",
"ap-northeast-3", "ap-northeast-2", "ap-nor [...]
@@ -52,7 +52,7 @@
"properties": {
"streamName": { "index": 0, "kind": "path", "displayName": "Stream Name",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Name of the stream" },
"cborEnabled": { "index": 1, "kind": "parameter", "displayName": "Cbor
Enabled", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "This option will set the
CBOR_ENABLED property during the execution" },
- "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be [...]
+ "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be [...]
"uriEndpointOverride": { "index": 3, "kind": "parameter", "displayName":
"Uri Endpoint Override", "group": "common", "label": "common", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Configuration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combinati [...]
"operation": { "index": 4, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "producer", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.aws2.firehose.KinesisFirehose2Operations", "enum":
[ "sendBatchRecord", "createDeliveryStream", "deleteDeliveryStream",
"describeDeliveryStream", "updateDestination" ], "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.firehose.Ki [...]
"region": { "index": 5, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "us-west-1",
"us-west-2", "af-south-1", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1",
"ap-northeast-3", "ap-northeast-2", "ap-no [...]
diff --git
a/components/camel-aws/camel-aws2-kinesis/src/generated/resources/org/apache/camel/component/aws2/kinesis/aws2-kinesis.json
b/components/camel-aws/camel-aws2-kinesis/src/generated/resources/org/apache/camel/component/aws2/kinesis/aws2-kinesis.json
index 9c12e15044c..7de14d632ad 100644
---
a/components/camel-aws/camel-aws2-kinesis/src/generated/resources/org/apache/camel/component/aws2/kinesis/aws2-kinesis.json
+++
b/components/camel-aws/camel-aws2-kinesis/src/generated/resources/org/apache/camel/component/aws2/kinesis/aws2-kinesis.json
@@ -25,7 +25,7 @@
"componentProperties": {
"cborEnabled": { "index": 0, "kind": "property", "displayName": "Cbor
Enabled", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "This option will set the
CBOR_ENABLED property during the execution" },
"configuration": { "index": 1, "kind": "property", "displayName":
"Configuration", "group": "common", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration", "deprecated":
false, "autowired": false, "secret": false, "description": "Component
configuration" },
- "overrideEndpoint": { "index": 2, "kind": "property", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in co [...]
+ "overrideEndpoint": { "index": 2, "kind": "property", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in co [...]
"region": { "index": 3, "kind": "property", "displayName": "Region",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "us-west-1",
"us-west-2", "af-south-1", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1",
"ap-northeast-3", "ap-northeast-2", "ap-north [...]
"uriEndpointOverride": { "index": 4, "kind": "property", "displayName":
"Uri Endpoint Override", "group": "common", "label": "common", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with ov [...]
"bridgeErrorHandler": { "index": 5, "kind": "property", "displayName":
"Bridge Error Handler", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Allows for bridging the consumer to the Camel routing Error Handler, which
mean any exceptions (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
@@ -62,7 +62,7 @@
"properties": {
"streamName": { "index": 0, "kind": "path", "displayName": "Stream Name",
"group": "common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Name of the stream" },
"cborEnabled": { "index": 1, "kind": "parameter", "displayName": "Cbor
Enabled", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "This option will set the
CBOR_ENABLED property during the execution" },
- "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in c [...]
+ "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "common", "label": "common", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in c [...]
"region": { "index": 3, "kind": "parameter", "displayName": "Region",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "us-west-1",
"us-west-2", "af-south-1", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1",
"ap-northeast-3", "ap-northeast-2", "ap-nort [...]
"uriEndpointOverride": { "index": 4, "kind": "parameter", "displayName":
"Uri Endpoint Override", "group": "common", "label": "common", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with o [...]
"iteratorType": { "index": 5, "kind": "parameter", "displayName":
"Iterator Type", "group": "consumer", "label": "consumer", "required": false,
"type": "object", "javaType":
"software.amazon.awssdk.services.kinesis.model.ShardIteratorType", "enum": [
"AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER", "TRIM_HORIZON", "LATEST",
"AT_TIMESTAMP", "null" ], "deprecated": false, "autowired": false, "secret":
false, "defaultValue": "TRIM_HORIZON", "configurationClass":
"org.apache.camel.componen [...]
diff --git
a/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
b/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
index 42410cc8545..ed15538da3a 100644
---
a/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
+++
b/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
@@ -18,13 +18,13 @@
The AWS2 Kinesis component supports consuming messages from and producing
messages to Amazon Kinesis (no Batch supported)
service.
-AWS2 Kinesis component also supports Synchronous and Asynchronous Client which
means you choose what fits best your requirements,
-so if you need the connection (client) to be async there's a property of
'asyncClient' (in DSL also can be found) needs to be turned true.
+The AWS2 Kinesis component also supports Synchronous and Asynchronous Client,
which means you choose what fits best your requirements,
+so if you need the connection (client) to be async, there's a property of
'asyncClient' (in DSL also can be found) needs to be turned true.
Prerequisites
You must have a valid Amazon Web Services developer account, and be
-signed up to use Amazon Kinesis. More information are available
+signed up to use Amazon Kinesis. More information is available
at https://aws.amazon.com/kinesis/[AWS Kinesis]
@@ -34,9 +34,11 @@ at https://aws.amazon.com/kinesis/[AWS Kinesis]
aws2-kinesis://stream-name[?options]
-----------------------------------
-The stream needs to be created prior to it being used. +
-You can append query options to the URI in the following format,
-?options=value&option2=value&...
+The stream needs to be created prior to it being used.
+
+You can append query options to the URI in the following format:
+
+`?options=value&option2=value&...`
// component-configure options: START
@@ -63,28 +65,28 @@ configured.
This component implements the Batch Consumer.
-This allows you for instance to know how many messages exists in this
-batch and for instance let the Aggregator
+This allows you, for instance, to know how many messages exist in this
+batch and for instance, let the Aggregator
aggregate this number of messages.
The consumer is able to consume either from a single specific shard or
-all available shards (multiple shards consumption) of Amazon Kinesis therefore
if you leave the 'shardId'
-property in the DSL configuration empty then it'll consume all available shards
+all available shards (multiple shards consumption) of Amazon Kinesis,
therefore, if you leave the 'shardId'
+property in the DSL configuration empty, then it'll consume all available
shards
otherwise only the specified shard corresponding to the shardId will be
consumed.
== Usage
=== Static credentials, Default Credential Provider and Profile Credentials
Provider
-You have the possibility of avoiding the usage of explicit static credentials,
by specifying the useDefaultCredentialsProvider option and set it to true.
+You have the possibility of avoiding the usage of explicit static credentials
by specifying the useDefaultCredentialsProvider option and set it to true.
The order of evaluation for Default Credentials Provider is the following:
-- Java system properties - aws.accessKeyId and aws.secretKey
-- Environment variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
+- Java system properties - `aws.accessKeyId` and `aws.secretKey`.
+- Environment variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
- Web Identity Token from AWS STS.
- The shared credentials and config files.
-- Amazon ECS container credentials - loaded from the Amazon ECS if the
environment variable AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set.
+- Amazon ECS container credentials - loaded from the Amazon ECS if the
environment variable `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` is set.
- Amazon EC2 Instance profile credentials.
You have also the possibility of using Profile Credentials Provider, by
specifying the useProfileCredentialsProvider option to true and
profileCredentialsName to the profile name.
diff --git
a/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc
b/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc
index 69d8f1a6686..4927c0ac102 100644
---
a/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc
+++
b/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc
@@ -20,7 +20,7 @@ The AWS2 Kinesis Firehose component supports sending messages
to Amazon Kinesis
Prerequisites
You must have a valid Amazon Web Services developer account, and be
-signed up to use Amazon Kinesis Firehose. More information are available
+signed up to use Amazon Kinesis Firehose. More information is available
at https://aws.amazon.com/kinesis/firehose/[AWS Kinesis Firehose]
[NOTE]
@@ -35,9 +35,11 @@ The AWS2 Kinesis Firehose component is not supported in OSGI
aws2-kinesis-firehose://delivery-stream-name[?options]
-----------------------------------
-The stream needs to be created prior to it being used. +
- You can append query options to the URI in the following format,
-?options=value&option2=value&...
+The stream needs to be created prior to it being used.
+
+You can append query options to the URI in the following format:
+
+`?options=value&option2=value&...`
== URI Options
@@ -79,15 +81,15 @@ configured.
=== Static credentials, Default Credential Provider and Profile Credentials
Provider
-You have the possibility of avoiding the usage of explicit static credentials,
by specifying the useDefaultCredentialsProvider option and set it to true.
+You have the possibility of avoiding the usage of explicit static credentials
by specifying the useDefaultCredentialsProvider option and set it to true.
The order of evaluation for Default Credentials Provider is the following:
- - Java system properties - aws.accessKeyId and aws.secretKey
- - Environment variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
+ - Java system properties - `aws.accessKeyId` and `aws.secretKey`
+ - Environment variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
- Web Identity Token from AWS STS.
- The shared credentials and config files.
- - Amazon ECS container credentials - loaded from the Amazon ECS if the
environment variable AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set.
+ - Amazon ECS container credentials - loaded from the Amazon ECS if the
environment variable `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` is set.
- Amazon EC2 Instance profile credentials.
You have also the possibility of using Profile Credentials Provider, by
specifying the useProfileCredentialsProvider option to true and
profileCredentialsName to the profile name.
@@ -131,7 +133,7 @@ Camel-AWS s3 component provides the following operation on
the producer side:
=== Send Batch Records Example
-You can send an iterable of Kinesis Record (as the following example shows) or
you can send directly a PutRecordBatchRequest POJO instance in the body.
+You can send an iterable of Kinesis Record (as the following example shows),
or you can send directly a PutRecordBatchRequest POJO instance in the body.
[source,java]
--------------------------------------------------------------------------------------------------------------------
diff --git
a/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/firehose/KinesisFirehose2Configuration.java
b/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/firehose/KinesisFirehose2Configuration.java
index 5062f50100e..99fa74b1532 100644
---
a/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/firehose/KinesisFirehose2Configuration.java
+++
b/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/firehose/KinesisFirehose2Configuration.java
@@ -59,7 +59,7 @@ public class KinesisFirehose2Configuration implements
Cloneable {
description = "This option will set the CBOR_ENABLED property
during the execution")
private boolean cborEnabled = true;
@UriParam(label = "common",
- description = "Set the need for overidding the endpoint. This
option needs to be used in combination with uriEndpointOverride"
+ description = "Set the need for overriding the endpoint. This
option needs to be used in combination with uriEndpointOverride"
+ " option")
private boolean overrideEndpoint;
@UriParam(label = "common",
diff --git
a/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/kinesis/Kinesis2Configuration.java
b/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/kinesis/Kinesis2Configuration.java
index 92d9a4c5ece..b086bd567f6 100644
---
a/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/kinesis/Kinesis2Configuration.java
+++
b/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/kinesis/Kinesis2Configuration.java
@@ -78,7 +78,7 @@ public class Kinesis2Configuration implements Cloneable {
description = "This option will set the CBOR_ENABLED property
during the execution")
private boolean cborEnabled = true;
@UriParam(label = "common", defaultValue = "false",
- description = "Set the need for overidding the endpoint. This
option needs to be used in combination with uriEndpointOverride"
+ description = "Set the need for overriding the endpoint. This
option needs to be used in combination with uriEndpointOverride"
+ " option")
private boolean overrideEndpoint;
@UriParam(label = "common",
