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 2021/02/26 15:43:01 UTC
[camel] 05/06: CAMEL-16171 - Add uri-endpoint-override options to
all AWS2 components - AWS2-DDB Streams component
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 1775c26dd019c62b3cc318f692707b84ef5fc8a3
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Fri Feb 26 15:54:52 2021 +0100
CAMEL-16171 - Add uri-endpoint-override options to all AWS2 components - AWS2-DDB Streams component
---
.../camel/catalog/components/aws2-ddbstream.json | 4 +
.../org/apache/camel/catalog/docs/yaml-dsl.adoc | 216 ---------------------
2 files changed, 4 insertions(+), 216 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-ddbstream.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-ddbstream.json
index d129530..625a028 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-ddbstream.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-ddbstream.json
@@ -27,12 +27,14 @@
"configuration": { "kind": "property", "displayName": "Configuration", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The component configuration" },
"iteratorType": { "kind": "property", "displayName": "Iterator Type", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "software.amazon.awssdk.services.dynamodb.model.ShardIteratorType", "enum": [ "TRIM_HORIZON", "LATEST", "AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER", "null" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "LATEST", "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfigu [...]
"maxResultsPerRequest": { "kind": "property", "displayName": "Max Results Per Request", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Maximum number of records that will be fetched in each poll" },
+ "overrideEndpoint": { "kind": "property", "displayName": "Override Endpoint", "group": "consumer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Set the need for overidding the endpoint. This option needs to be used in combination wi [...]
"proxyHost": { "kind": "property", "displayName": "Proxy Host", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the DDBStreams client" },
"proxyPort": { "kind": "property", "displayName": "Proxy Port", "group": "consumer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the DDBStreams client" },
"proxyProtocol": { "kind": "property", "displayName": "Proxy Protocol", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when ins [...]
"region": { "kind": "property", "displayName": "Region", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "The region in which DDBStreams client needs to work" },
"sequenceNumberProvider": { "kind": "property", "displayName": "Sequence Number Provider", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws2.ddbstream.SequenceNumberProvider", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Provider for the sequence number w [...]
"trustAllCertificates": { "kind": "property", "displayName": "Trust All Certificates", "group": "consumer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "If we want to trust all certificates in case of overriding the endpoint" },
+ "uriEndpointOverride": { "kind": "property", "displayName": "Uri Endpoint Override", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoi [...]
"autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which t [...]
"accessKey": { "kind": "property", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" },
"secretKey": { "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" }
@@ -43,6 +45,7 @@
"bridgeErrorHandler": { "kind": "parameter", "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 occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a m [...]
"iteratorType": { "kind": "parameter", "displayName": "Iterator Type", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "software.amazon.awssdk.services.dynamodb.model.ShardIteratorType", "enum": [ "TRIM_HORIZON", "LATEST", "AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER", "null" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "LATEST", "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfig [...]
"maxResultsPerRequest": { "kind": "parameter", "displayName": "Max Results Per Request", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Maximum number of records that will be fetched in each poll" },
+ "overrideEndpoint": { "kind": "parameter", "displayName": "Override Endpoint", "group": "consumer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Set the need for overidding the endpoint. This option needs to be used in combination w [...]
"proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the DDBStreams client" },
"proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "consumer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the DDBStreams client" },
"proxyProtocol": { "kind": "parameter", "displayName": "Proxy Protocol", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when in [...]
@@ -50,6 +53,7 @@
"sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." },
"sequenceNumberProvider": { "kind": "parameter", "displayName": "Sequence Number Provider", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws2.ddbstream.SequenceNumberProvider", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Provider for the sequence number [...]
"trustAllCertificates": { "kind": "parameter", "displayName": "Trust All Certificates", "group": "consumer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "If we want to trust all certificates in case of overriding the endpoint" },
+ "uriEndpointOverride": { "kind": "parameter", "displayName": "Uri Endpoint Override", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration", "configurationField": "configuration", "description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpo [...]
"exceptionHandler": { "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "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 con [...]
"exchangePattern": { "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut", "InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." },
"pollStrategy": { "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation [...]
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc
deleted file mode 100644
index 080603d..0000000
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc
+++ /dev/null
@@ -1,216 +0,0 @@
-[[yaml-dsl-other]]
-= Yaml Dsl Component
-:docTitle: Yaml Dsl
-:artifactId: camel-yaml-dsl
-:description: Camel DSL with YAML
-:since: 3.9
-:supportLevel: Preview
-include::{cq-version}@camel-quarkus:ROOT:partial$reference/others/yaml-dsl.adoc[opts=optional]
-//Manually maintained attributes
-:group: DSL
-
-*Since Camel {since}*
-
-== Defining a route
-
-A route is collection of elements defined as follows:
-
-[source,yaml]
-----
-- from: #<1>
- uri: "direct:start"
- steps: #<2>
- - filter:
- expression:
- simple: "${in.header.continue} == true"
- steps: #<2>
- - to:
- uri: "log:filtered"
- - to:
- uri: "log:original"
-----
-<1> route entry point, by default `from` and `rest` are supported
-<2> processing steps
-
-[NOTE]
-====
-Each step is represented by a YAML map that has a single entry where the field name is the EIP name
-====
-
-As general rule each step provide all the parameters the related definition declares but there are some minor differences/enhancements:
-
-- *Output Aware Steps*
-+
-Some steps such as `filter` and `split` have their own pipeline when an exchange matches the filter expression or for the items generated by the split expression, such pipeline can be defined by the `steps` field:
-+
-[source,yaml]
-----
-filter:
- expression:
- simple: "${in.header.continue} == true"
- steps:
- - to:
- uri: "log:filtered"
-----
-+
-
-- *Expression Aware Steps*
-+
-Some EIP such as `filter` and `split` supports the definition of an expression through the `expression` field:
-+
-[source,yaml]
-.Explicit Expression field
-----
-filter:
- expression:
- simple: "${in.header.continue} == true"
-----
-+
-To make the DSL less verbose, the `expression` field can be omitted:
-+
-[source,yaml]
-.Implicit Expression field
-----
-filter:
- simple: "${in.header.continue} == true"
-----
-+
-In general expression can be defined inline like in the examples above but in case you need provide more information, you can 'unroll' the expression definition and configure any single parameter the expression defines.
-+
-[source,yaml]
-.Full Expression definition
-----
-filter:
- tokenize:
- token: "<"
- end-token: ">"
-----
-
-- *Data Format Aware Steps*
-+
-Some EIP such as `set-body` and `marshal` supports the definition of data formats through the `data-format` field:
-+
-[source,yaml]
-.Explicit Data Format field
-----
-set-body:
- data-format:
- json:
- library: Gson
-----
-+
-To make the DSL less verbose, the `data-format` field can be omitted:
-+
-[source,yaml]
-.Implicit Data Format field
-----
-set-body:
- json:
- library: Gson
-----
-+
-[NOTE]
-====
-In case you want to use the data-format's default settings, you need to place an empty block as data format parameters, like `json: {}`
-====
-
-== Defining endpoints
-
-To define an endpoint with the YAML dsl you have three options:
-
-. Using a classic Camel URI:
-+
-[source,yaml]
-----
-- from:
- uri: "timer:tick?period=1s"
- steps:
- - to:
- uri: "telegram:bots?authorizationToken=XXX"
-----
-. Using URI and parameters:
-+
-[source,yaml]
-----
-- from:
- uri: "timer://tick"
- parameters:
- period: "1s"
- steps:
- - to:
- uri: "telegram:bots"
- parameters:
- authorizationToken: "XXX"
-----
-. Using the YAML implementation of the xref:latest@manual::Endpoint-dsl.adoc[Endpoint DSL]:
-+
-[source,yaml]
-----
-- from:
- timer:
- name: "tick"
- period: "1s"
- steps:
- - telegram:
- type: "bots"
- authorizationToken: "XXX"
-----
-
-[WARNING]
-====
-Support for the Endpoint DSL with YAML is experimental and subject to changes.
-====
-[NOTE]
-====
-Support for Endpoint DSL auto completion https://github.com/apache/camel-k-runtime/issues/485[is not yet available].
-====
-
-== Defining beans
-
-In addition to the general support for creating beans provided by xref:latest@components:others:main.adoc#_specifying_custom_beans[Camel Main], the YAML DSL provide a convenient syntax to define and configure them:
-
-[source,yaml]
-----
-- beans:
- - name: beanFromMap # <1>
- type: com.acme.MyBean # <2>
- properties: # <3>
- foo: bar
-----
-<1> the name of the bean which will be used to bound the instance to the Camel Registry
-<2> the full qualified class name of the bean
-<3> the properties of the bean to be set
-
-The properties of the bean can be defined using either a map or properties style as shown in the example below:
-
-[source,yaml]
-----
-- beans:
- # map style
- - name: beanFromMap
- type: com.acme.MyBean
- properties:
- field1: 'f1'
- field2: 'f2'
- nested:
- field1: 'nf1'
- field2: 'nf2'
- # properties style
- - name: beanFromProps
- type: com.acme.MyBean
- properties:
- field1: 'f1_p'
- field2: 'f2_p'
- nested.field1: 'nf1_p'
- nested.field2: 'nf2_p'
-----
-
-[NOTE]
-====
-The `beans` elements can only be used as root element
-====
-
-== Examples
-
-You can find a set of examples using `camel-yaml-dsl` in https://github.com/apache/camel-examples[Camel Examples]
-which demonstrate creating Camel Routes with YAML.