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 fa9a272a45643221b35138ad928da9f378792ab4 Author: Andrea Cosentino <anco...@gmail.com> AuthorDate: Wed Sep 11 17:32:00 2019 +0200 CAMEL-13435 - Full build and regen --- components/readme.adoc | 5 +- docs/components/modules/ROOT/nav.adoc | 1 + .../ROOT/pages/aws-translate-component.adoc | 175 +++++++++++++++++++++ 3 files changed, 180 insertions(+), 1 deletion(-) diff --git a/components/readme.adoc b/components/readme.adoc index 74f10cd..aab2efd 100644 --- a/components/readme.adoc +++ b/components/readme.adoc @@ -1,7 +1,7 @@ = Components // components: START -Number of Components: 299 in 237 JAR artifacts (0 deprecated) +Number of Components: 300 in 238 JAR artifacts (0 deprecated) [width="100%",cols="4,1,5",options="header"] |=== @@ -124,6 +124,9 @@ Number of Components: 299 in 237 JAR artifacts (0 deprecated) | link:camel-aws-sdb/src/main/docs/aws-sdb-component.adoc[AWS SimpleDB] (camel-aws-sdb) + `aws-sdb:domainName` | 2.9 | The aws-sdb component is for storing and retrieving data from/to Amazon's SDB service. +| link:camel-aws-translate/src/main/docs/aws-translate-component.adoc[AWS Translate] (camel-aws-translate) + +`aws-translate:label` | 3.0 | The aws-kms is used for managing Amazon Translate + | link:camel-azure/src/main/docs/azure-blob-component.adoc[Azure Storage Blob Service] (camel-azure) + `azure-blob:containerOrBlobUri` | 2.19 | The azure-blob component is used for storing and retrieving blobs from Azure Storage Blob Service. diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc index d983783..3e5ee2a 100644 --- a/docs/components/modules/ROOT/nav.adoc +++ b/docs/components/modules/ROOT/nav.adoc @@ -41,6 +41,7 @@ * xref:aws-sns-component.adoc[AWS Simple Notification System Component] * xref:aws-sqs-component.adoc[AWS Simple Queue Service Component] * xref:aws-swf-component.adoc[AWS Simple Workflow Component] +* xref:aws-translate-component.adoc[AWS Translate Component] * xref:aws-xray.adoc[AWS XRay Component] * xref:azure-blob-component.adoc[Azure Storage Blob Service Component] * xref:azure-queue-component.adoc[Azure Storage Queue Service Component] diff --git a/docs/components/modules/ROOT/pages/aws-translate-component.adoc b/docs/components/modules/ROOT/pages/aws-translate-component.adoc new file mode 100644 index 0000000..14254cc --- /dev/null +++ b/docs/components/modules/ROOT/pages/aws-translate-component.adoc @@ -0,0 +1,175 @@ +[[aws-translate-component]] += AWS Translate Component +:page-source: components/camel-aws-translate/src/main/docs/aws-translate-component.adoc + +*Available as of Camel version 3.0* + +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 5 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *configuration* (advanced) | The AWS Translate default configuration | | TranslateConfiguration +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *secretKey* (producer) | Amazon AWS Secret Key | | String +| *region* (producer) | The region in which Translate client needs to work | | String +| *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | 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 (10 parameters): + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *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 | | 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 +| *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 +| *translateClient* (producer) | To use a existing configured AWS Translate as client | | AmazonTranslate +| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== +// endpoint options: END +// spring-boot-auto-configure options: START +== Spring Boot Auto-Configuration + +When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration: + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-aws-translate-starter</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---- + + +The component supports 12 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.aws-translate.access-key* | Amazon AWS Access Key | | String +| *camel.component.aws-translate.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean +| *camel.component.aws-translate.configuration.access-key* | Amazon AWS Access Key | | String +| *camel.component.aws-translate.configuration.operation* | The operation to perform | | TranslateOperations +| *camel.component.aws-translate.configuration.proxy-host* | To define a proxy host when instantiating the Translate client | | String +| *camel.component.aws-translate.configuration.proxy-port* | To define a proxy port when instantiating the Translate client | | Integer +| *camel.component.aws-translate.configuration.region* | 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 +| *camel.component.aws-translate.configuration.secret-key* | Amazon AWS Secret Key | | String +| *camel.component.aws-translate.configuration.translate-client* | To use a existing configured AWS Translate as client | | AmazonTranslate +| *camel.component.aws-translate.enabled* | Whether to enable auto configuration of the aws-translate component. This is enabled by default. | | Boolean +| *camel.component.aws-translate.region* | The region in which Translate client needs to work | | String +| *camel.component.aws-translate.secret-key* | Amazon AWS Secret Key | | String +|=== +// spring-boot-auto-configure options: END + + + + +Required EKS 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 + +|`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. + +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. +