You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2020/02/17 18:22:45 UTC
[camel] 01/02: Camel-Aws2-IAM: Update some descriptions
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 963ee9d033de9eee9bbbc7a15c97522dc1baa29b
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Mon Feb 17 19:15:40 2020 +0100
Camel-Aws2-IAM: Update some descriptions
---
.../resources/org/apache/camel/component/aws2/iam/aws2-iam.json | 4 ++--
components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc | 2 +-
.../java/org/apache/camel/component/aws2/iam/IAM2Component.java | 2 +-
.../org/apache/camel/component/aws2/iam/IAM2Configuration.java | 7 ++++---
.../java/org/apache/camel/component/aws2/iam/IAM2Endpoint.java | 2 +-
.../apache/camel/builder/component/ComponentsBuilderFactory.java | 2 +-
.../builder/component/dsl/Aws2IamComponentBuilderFactory.java | 4 ++--
core/camel-componentdsl/src/generated/resources/metadata.json | 2 +-
8 files changed, 13 insertions(+), 12 deletions(-)
diff --git a/components/camel-aws2-iam/src/generated/resources/org/apache/camel/component/aws2/iam/aws2-iam.json b/components/camel-aws2-iam/src/generated/resources/org/apache/camel/component/aws2/iam/aws2-iam.json
index 0d7c0e1..dea40a0 100644
--- a/components/camel-aws2-iam/src/generated/resources/org/apache/camel/component/aws2/iam/aws2-iam.json
+++ b/components/camel-aws2-iam/src/generated/resources/org/apache/camel/component/aws2/iam/aws2-iam.json
@@ -5,7 +5,7 @@
"extendsScheme": "",
"syntax": "aws2-iam:label",
"title": "AWS 2 IAM",
- "description": "The aws-iam is used for managing Amazon IAM",
+ "description": "The aws2-iam is used for managing Amazon IAM",
"label": "cloud,management",
"deprecated": false,
"async": false,
@@ -35,7 +35,7 @@
"proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the IAM client" },
"proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "producer", "label": "producer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the IAM client" },
"proxyProtocol": { "kind": "parameter", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the IAM client" },
- "region": { "kind": "parameter", "displayName": "Region", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration", "configurationField": "configuration", "description": "The region in which IAM client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_E [...]
+ "region": { "kind": "parameter", "displayName": "Region", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration", "configurationField": "configuration", "description": "The region in which IAM client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-eas [...]
"secretKey": { "kind": "parameter", "displayName": "Secret Key", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": true, "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" },
"basicPropertyBinding": { "kind": "parameter", "displayName": "Basic Property Binding", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities" },
"synchronous": { "kind": "parameter", "displayName": "Synchronous", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": "false", "description": "Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported)." }
diff --git a/components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc b/components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc
index 6817dec..ed1bf61 100644
--- a/components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc
+++ b/components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc
@@ -89,7 +89,7 @@ with the following path and query parameters:
| *proxyHost* (producer) | To define a proxy host when instantiating the IAM client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the IAM client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the IAM client. The value can be one of: HTTP, HTTPS | HTTPS | Protocol
-| *region* (producer) | The region in which IAM 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
+| *region* (producer) | The region in which IAM client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() | | String
| *secretKey* (producer) | Amazon AWS Secret Key | | String
| *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
diff --git a/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Component.java b/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Component.java
index 5d0a760..c7b2678 100644
--- a/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Component.java
+++ b/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Component.java
@@ -27,7 +27,7 @@ import org.apache.camel.support.DefaultComponent;
import software.amazon.awssdk.services.iam.IamClient;
/**
- * For working with Amazon IAM.
+ * For working with Amazon IAM SDK v2.
*/
@Component("aws2-iam")
public class IAM2Component extends DefaultComponent {
diff --git a/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Configuration.java b/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Configuration.java
index f13ed16..5b4cfd5 100644
--- a/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Configuration.java
+++ b/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Configuration.java
@@ -130,9 +130,10 @@ public class IAM2Configuration implements Cloneable {
}
/**
- * The region in which IAM 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()
+ * The region in which IAM client needs to work. When using this
+ * parameter, the configuration will expect the lowercase name of the
+ * region (for example ap-east-1) You'll need to use the name
+ * Region.EU_WEST_1.id()
*/
public void setRegion(String region) {
this.region = region;
diff --git a/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Endpoint.java b/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Endpoint.java
index aa3bbad..971fbf4 100644
--- a/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Endpoint.java
+++ b/components/camel-aws2-iam/src/main/java/org/apache/camel/component/aws2/iam/IAM2Endpoint.java
@@ -35,7 +35,7 @@ import software.amazon.awssdk.services.iam.IamClient;
import software.amazon.awssdk.services.iam.IamClientBuilder;
/**
- * The aws-iam is used for managing Amazon IAM
+ * The aws2-iam is used for managing Amazon IAM
*/
@UriEndpoint(firstVersion = "3.1.0", scheme = "aws2-iam", title = "AWS 2 IAM", syntax = "aws2-iam:label", producerOnly = true, label = "cloud,management")
public class IAM2Endpoint extends ScheduledPollEndpoint {
diff --git a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
index 82e2f38..d5d6668 100644
--- a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
+++ b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
@@ -531,7 +531,7 @@ public interface ComponentsBuilderFactory {
}
/**
* AWS 2 IAM (camel-aws2-iam)
- * The aws-iam is used for managing Amazon IAM
+ * The aws2-iam is used for managing Amazon IAM
*
* Category: cloud,management
* Since: 3.1
diff --git a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2IamComponentBuilderFactory.java b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2IamComponentBuilderFactory.java
index d3d61ec..ed93286 100644
--- a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2IamComponentBuilderFactory.java
+++ b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2IamComponentBuilderFactory.java
@@ -23,7 +23,7 @@ import org.apache.camel.builder.component.ComponentBuilder;
import org.apache.camel.component.aws2.iam.IAM2Component;
/**
- * The aws-iam is used for managing Amazon IAM
+ * The aws2-iam is used for managing Amazon IAM
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@@ -32,7 +32,7 @@ public interface Aws2IamComponentBuilderFactory {
/**
* AWS 2 IAM (camel-aws2-iam)
- * The aws-iam is used for managing Amazon IAM
+ * The aws2-iam is used for managing Amazon IAM
*
* Category: cloud,management
* Since: 3.1
diff --git a/core/camel-componentdsl/src/generated/resources/metadata.json b/core/camel-componentdsl/src/generated/resources/metadata.json
index 71ef8af..d36beb9 100644
--- a/core/camel-componentdsl/src/generated/resources/metadata.json
+++ b/core/camel-componentdsl/src/generated/resources/metadata.json
@@ -487,7 +487,7 @@
"extendsScheme": "",
"syntax": "aws2-iam:label",
"title": "AWS 2 IAM",
- "description": "The aws-iam is used for managing Amazon IAM",
+ "description": "The aws2-iam is used for managing Amazon IAM",
"label": "cloud,management",
"deprecated": false,
"deprecationNote": "cloud,management",