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/16 08:20:13 UTC
[camel] 03/05: CAMEL-16115 - Remove Camel-AWS-* components -
AWS-Translate
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 537f610158a43b8691dec17adea6a08af1094f26
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Tue Feb 16 09:12:22 2021 +0100
CAMEL-16115 - Remove Camel-AWS-* components - AWS-Translate
---
.../org/apache/camel/catalog/components.properties | 1 -
.../camel/catalog/components/aws-translate.json | 58 -------
.../org/apache/camel/catalog/docs.properties | 1 -
.../catalog/docs/aws-translate-component.adoc | 178 --------------------
docs/components/modules/ROOT/nav.adoc | 1 -
.../ROOT/pages/aws-translate-component.adoc | 180 ---------------------
6 files changed, 419 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties
index e72f38a..0a7eaab 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties
@@ -36,7 +36,6 @@ aws-ses
aws-sns
aws-sqs
aws-swf
-aws-translate
aws2-athena
aws2-cw
aws2-ddb
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-translate.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-translate.json
deleted file mode 100644
index 38c8837..0000000
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-translate.json
+++ /dev/null
@@ -1,58 +0,0 @@
-{
- "component": {
- "kind": "component",
- "name": "aws-translate",
- "title": "AWS Translate",
- "description": "Translate texts using AWS Translate.",
- "deprecated": true,
- "deprecatedSince": "3.8.0",
- "firstVersion": "3.0.0",
- "label": "cloud,management",
- "javaType": "org.apache.camel.component.aws.translate.TranslateComponent",
- "supportLevel": "Stable",
- "groupId": "org.apache.camel",
- "artifactId": "camel-aws-translate",
- "version": "3.9.0-SNAPSHOT",
- "scheme": "aws-translate",
- "extendsScheme": "",
- "syntax": "aws-translate:label",
- "async": false,
- "api": false,
- "consumerOnly": false,
- "producerOnly": true,
- "lenientProperties": false
- },
- "componentProperties": {
- "autoDiscoverClient": { "kind": "property", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a c [...]
- "accessKey": { "kind": "property", "displayName": "Access Key", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" },
- "autodetectSourceLanguage": { "kind": "property", "displayName": "Autodetect Source Language", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Being able to autodetect the source language" },
- "configuration": { "kind": "property", "displayName": "Configuration", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.translate.TranslateConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The component configuration" },
- "lazyStartProducer": { "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 during star [...]
- "operation": { "kind": "property", "displayName": "Operation", "group": "producer", "label": "producer", "required": true, "type": "object", "javaType": "org.apache.camel.component.aws.translate.TranslateOperations", "enum": [ "translateText" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "translateText", "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", [...]
- "proxyHost": { "kind": "property", "displayName": "Proxy Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the Translate client" },
- "proxyPort": { "kind": "property", "displayName": "Proxy Port", "group": "producer", "label": "producer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the Translate client" },
- "proxyProtocol": { "kind": "property", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the T [...]
- "region": { "kind": "property", "displayName": "Region", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "The region in which Translate client needs to work. When using this parameter, the configuration will expect the capitalized n [...]
- "secretKey": { "kind": "property", "displayName": "Secret Key", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" },
- "sourceLanguage": { "kind": "property", "displayName": "Source Language", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Source language to use" },
- "targetLanguage": { "kind": "property", "displayName": "Target Language", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Target language to use" },
- "translateClient": { "kind": "property", "displayName": "Translate Client", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "com.amazonaws.services.translate.AmazonTranslate", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "To use a existing configured AWS Translate as client" },
- "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 [...]
- },
- "properties": {
- "label": { "kind": "path", "displayName": "Label", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Logical name" },
- "autoDiscoverClient": { "kind": "parameter", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a [...]
- "accessKey": { "kind": "parameter", "displayName": "Access Key", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" },
- "autodetectSourceLanguage": { "kind": "parameter", "displayName": "Autodetect Source Language", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Being able to autodetect the source language" },
- "lazyStartProducer": { "kind": "parameter", "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 during sta [...]
- "operation": { "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": true, "type": "object", "javaType": "org.apache.camel.component.aws.translate.TranslateOperations", "enum": [ "translateText" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "translateText", "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", [...]
- "proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the Translate client" },
- "proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "producer", "label": "producer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the Translate client" },
- "proxyProtocol": { "kind": "parameter", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the [...]
- "region": { "kind": "parameter", "displayName": "Region", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "The region in which Translate client needs to work. When using this parameter, the configuration will expect the capitalized [...]
- "secretKey": { "kind": "parameter", "displayName": "Secret Key", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" },
- "sourceLanguage": { "kind": "parameter", "displayName": "Source Language", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Source language to use" },
- "targetLanguage": { "kind": "parameter", "displayName": "Target Language", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "Target language to use" },
- "translateClient": { "kind": "parameter", "displayName": "Translate Client", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "com.amazonaws.services.translate.AmazonTranslate", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.translate.TranslateConfiguration", "configurationField": "configuration", "description": "To use a existing configured AWS Translate as client" }
- }
-}
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties
index ec23757..1ce8c2d 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties
@@ -41,7 +41,6 @@ aws-sns-component
aws-sqs-component
aws-summary
aws-swf-component
-aws-translate-component
aws-xray
aws2-athena-component
aws2-cw-component
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-translate-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-translate-component.adoc
deleted file mode 100644
index 0b45630..0000000
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-translate-component.adoc
+++ /dev/null
@@ -1,178 +0,0 @@
-[[aws-translate-component]]
-= AWS Translate Component (deprecated)
-:docTitle: AWS Translate
-:artifactId: camel-aws-translate
-:description: Translate texts using AWS Translate.
-:since: 3.0
-:supportLevel: Stable-deprecated
-:deprecated: *deprecated*
-:component-header: Only producer is supported
-include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-translate.adoc[opts=optional]
-//Manually maintained attributes
-:group: AWS
-
-*Since Camel {since}*
-
-*{component-header}*
-
-The Translate component supports translate a text in multiple languages.
-https://aws.amazon.com/translate/[AWS Translate] clusters instances.
-
-Prerequisites
-
-You must have a valid Amazon Web Services developer account, and be
-signed up to use Amazon Translate. More information is available at
-https://aws.amazon.com/translate/[Amazon Translate].
-
-== URI Format
-
-[source,java]
--------------------------
-aws-translate://label[?options]
--------------------------
-
-You can append query options to the URI in the following format,
-?options=value&option2=value&...
-
-== URI Options
-
-
-// component options: START
-The AWS Translate component supports 15 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean
-| *accessKey* (producer) | Amazon AWS Access Key | | String
-| *autodetectSourceLanguage* (producer) | Being able to autodetect the source language | false | boolean
-| *configuration* (producer) | The component configuration | | TranslateConfiguration
-| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: translateText | translateText | TranslateOperations
-| *proxyHost* (producer) | To define a proxy host when instantiating the Translate client | | String
-| *proxyPort* (producer) | To define a proxy port when instantiating the Translate client | | Integer
-| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the Translate client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
-| *region* (producer) | The region in which Translate 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
-| *secretKey* (producer) | Amazon AWS Secret Key | | String
-| *sourceLanguage* (producer) | Source language to use | | String
-| *targetLanguage* (producer) | Target language to use | | String
-| *translateClient* (producer) | To use a existing configured AWS Translate as client | | AmazonTranslate
-| *autowiredEnabled* (advanced) | 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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean
-|===
-// component options: END
-
-
-
-
-// endpoint options: START
-The AWS Translate endpoint is configured using URI syntax:
-
-----
-aws-translate:label
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *label* | *Required* Logical name | | String
-|===
-
-
-=== Query Parameters (13 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean
-| *accessKey* (producer) | Amazon AWS Access Key | | String
-| *autodetectSourceLanguage* (producer) | Being able to autodetect the source language | 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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: translateText | translateText | TranslateOperations
-| *proxyHost* (producer) | To define a proxy host when instantiating the Translate client | | String
-| *proxyPort* (producer) | To define a proxy port when instantiating the Translate client | | Integer
-| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the Translate client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
-| *region* (producer) | The region in which Translate 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
-| *secretKey* (producer) | Amazon AWS Secret Key | | String
-| *sourceLanguage* (producer) | Source language to use | | String
-| *targetLanguage* (producer) | Target language to use | | String
-| *translateClient* (producer) | To use a existing configured AWS Translate as client | | AmazonTranslate
-|===
-// endpoint options: END
-
-
-
-
-Required Translate component options
-
-You have to provide the amazonTranslateClient in the
-Registry or your accessKey and secretKey to access
-the https://aws.amazon.com/translate/[Amazon Translate] service.
-
-== Usage
-
-=== Message headers evaluated by the Translate producer
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Header |Type |Description
-
-|`CamelAwsTranslateSourceLanguage` |`String` |The text source language
-
-|`CamelAwsTranslateTargetLanguage` |`String` |The text target language
-
-|`CamelAwsTranslateTerminologyNames` |`String` |The terminologies to use
-
-|`CamelAwsTranslateOperation` |`String` |The operation to perform
-|=======================================================================
-
-=== Translate Producer operations
-
-Camel-AWS Translate component provides the following operation on the producer side:
-
-- translateText
-
-== Automatic detection of AmazonTranslate client in registry
-
-The component is capable of detecting the presence of an AmazonTranslate bean into the registry.
-If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter.
-This may be really useful for smarter configuration of the endpoint.
-
-== Translate Text example
-
-------------------------------------------------------------------------------------------------------
-from("direct:start")
- .setHeader(TranslateConstants.SOURCE_LANGUAGE, TranslateLanguageEnum.ITALIAN)
- .setHeader(TranslateConstants.TARGET_LANGUAGE, TranslateLanguageEnum.GERMAN)
- .setBody("Ciao")
- .to("aws-translate://test?translateClient=#amazonTranslateClient&operation=translateText");
-------------------------------------------------------------------------------------------------------
-
-As result you'll get an exchange containing the translated text.
-
-Dependencies
-
-Maven users will need to add the following dependency to their pom.xml.
-
-*pom.xml*
-
-[source,xml]
----------------------------------------
-<dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-aws-translate</artifactId>
- <version>${camel-version}</version>
-</dependency>
----------------------------------------
-
-where `$\{camel-version}` must be replaced by the actual version of Camel.
-
-
-include::camel-spring-boot::page$aws-translate-starter.adoc[]
diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc
index 63724eda..0b396c2 100644
--- a/docs/components/modules/ROOT/nav.adoc
+++ b/docs/components/modules/ROOT/nav.adoc
@@ -40,7 +40,6 @@
*** xref:aws-sns-component.adoc[AWS Simple Notification System (SNS)]
*** xref:aws-sqs-component.adoc[AWS Simple Queue Service (SQS)]
*** xref:aws-swf-component.adoc[AWS Simple Workflow (SWF)]
-*** xref:aws-translate-component.adoc[AWS Translate]
** xref:aws2-summary.adoc[AWS 2]
*** xref:aws2-athena-component.adoc[AWS 2 Athena]
*** xref:aws2-cw-component.adoc[AWS 2 CloudWatch]
diff --git a/docs/components/modules/ROOT/pages/aws-translate-component.adoc b/docs/components/modules/ROOT/pages/aws-translate-component.adoc
deleted file mode 100644
index a37e22a..0000000
--- a/docs/components/modules/ROOT/pages/aws-translate-component.adoc
+++ /dev/null
@@ -1,180 +0,0 @@
-[[aws-translate-component]]
-= AWS Translate Component (deprecated)
-//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
-:page-source: components/camel-aws-translate/src/main/docs/aws-translate-component.adoc
-:docTitle: AWS Translate
-:artifactId: camel-aws-translate
-:description: Translate texts using AWS Translate.
-:since: 3.0
-:supportLevel: Stable-deprecated
-:deprecated: *deprecated*
-:component-header: Only producer is supported
-include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-translate.adoc[opts=optional]
-//Manually maintained attributes
-:group: AWS
-
-*Since Camel {since}*
-
-*{component-header}*
-
-The Translate component supports translate a text in multiple languages.
-https://aws.amazon.com/translate/[AWS Translate] clusters instances.
-
-Prerequisites
-
-You must have a valid Amazon Web Services developer account, and be
-signed up to use Amazon Translate. More information is available at
-https://aws.amazon.com/translate/[Amazon Translate].
-
-== URI Format
-
-[source,java]
--------------------------
-aws-translate://label[?options]
--------------------------
-
-You can append query options to the URI in the following format,
-?options=value&option2=value&...
-
-== URI Options
-
-
-// component options: START
-The AWS Translate component supports 15 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean
-| *accessKey* (producer) | Amazon AWS Access Key | | String
-| *autodetectSourceLanguage* (producer) | Being able to autodetect the source language | false | boolean
-| *configuration* (producer) | The component configuration | | TranslateConfiguration
-| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: translateText | translateText | TranslateOperations
-| *proxyHost* (producer) | To define a proxy host when instantiating the Translate client | | String
-| *proxyPort* (producer) | To define a proxy port when instantiating the Translate client | | Integer
-| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the Translate client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
-| *region* (producer) | The region in which Translate 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
-| *secretKey* (producer) | Amazon AWS Secret Key | | String
-| *sourceLanguage* (producer) | Source language to use | | String
-| *targetLanguage* (producer) | Target language to use | | String
-| *translateClient* (producer) | To use a existing configured AWS Translate as client | | AmazonTranslate
-| *autowiredEnabled* (advanced) | 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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean
-|===
-// component options: END
-
-
-
-
-// endpoint options: START
-The AWS Translate endpoint is configured using URI syntax:
-
-----
-aws-translate:label
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *label* | *Required* Logical name | | String
-|===
-
-
-=== Query Parameters (13 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean
-| *accessKey* (producer) | Amazon AWS Access Key | | String
-| *autodetectSourceLanguage* (producer) | Being able to autodetect the source language | 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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: translateText | translateText | TranslateOperations
-| *proxyHost* (producer) | To define a proxy host when instantiating the Translate client | | String
-| *proxyPort* (producer) | To define a proxy port when instantiating the Translate client | | Integer
-| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the Translate client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
-| *region* (producer) | The region in which Translate 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
-| *secretKey* (producer) | Amazon AWS Secret Key | | String
-| *sourceLanguage* (producer) | Source language to use | | String
-| *targetLanguage* (producer) | Target language to use | | String
-| *translateClient* (producer) | To use a existing configured AWS Translate as client | | AmazonTranslate
-|===
-// endpoint options: END
-
-
-
-
-Required Translate component options
-
-You have to provide the amazonTranslateClient in the
-Registry or your accessKey and secretKey to access
-the https://aws.amazon.com/translate/[Amazon Translate] service.
-
-== Usage
-
-=== Message headers evaluated by the Translate producer
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Header |Type |Description
-
-|`CamelAwsTranslateSourceLanguage` |`String` |The text source language
-
-|`CamelAwsTranslateTargetLanguage` |`String` |The text target language
-
-|`CamelAwsTranslateTerminologyNames` |`String` |The terminologies to use
-
-|`CamelAwsTranslateOperation` |`String` |The operation to perform
-|=======================================================================
-
-=== Translate Producer operations
-
-Camel-AWS Translate component provides the following operation on the producer side:
-
-- translateText
-
-== Automatic detection of AmazonTranslate client in registry
-
-The component is capable of detecting the presence of an AmazonTranslate bean into the registry.
-If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter.
-This may be really useful for smarter configuration of the endpoint.
-
-== Translate Text example
-
-------------------------------------------------------------------------------------------------------
-from("direct:start")
- .setHeader(TranslateConstants.SOURCE_LANGUAGE, TranslateLanguageEnum.ITALIAN)
- .setHeader(TranslateConstants.TARGET_LANGUAGE, TranslateLanguageEnum.GERMAN)
- .setBody("Ciao")
- .to("aws-translate://test?translateClient=#amazonTranslateClient&operation=translateText");
-------------------------------------------------------------------------------------------------------
-
-As result you'll get an exchange containing the translated text.
-
-Dependencies
-
-Maven users will need to add the following dependency to their pom.xml.
-
-*pom.xml*
-
-[source,xml]
----------------------------------------
-<dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-aws-translate</artifactId>
- <version>${camel-version}</version>
-</dependency>
----------------------------------------
-
-where `$\{camel-version}` must be replaced by the actual version of Camel.
-
-
-include::camel-spring-boot::page$aws-translate-starter.adoc[]