This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new eb9f43b Huawei DMS update doc and comments (#5989)
eb9f43b is described below
commit eb9f43b296b5cab1b74d52df0198b2077d01407f
Author: Hokutor <[email protected]>
AuthorDate: Thu Aug 26 00:42:14 2021 -0400
Huawei DMS update doc and comments (#5989)
* Huawei DMS Doc Update
* Update code comments
---
.../src/main/docs/hwcloud-dms-component.adoc | 64 ++++++++++++++++++++++
.../dms/CreateInstanceJsonFunctionalTest.java | 2 +
.../dms/CreateInstanceKafkaFunctionalTest1.java | 1 +
.../dms/CreateInstanceKafkaFunctionalTest2.java | 1 +
.../dms/CreateInstancePojoFunctionalTest.java | 2 +
.../dms/CreateInstanceRmqFunctionalTest1.java | 1 +
.../dms/CreateInstanceRmqFunctionalTest2.java | 1 +
.../dms/UpdateInstanceJsonFunctionalTest.java | 2 +
.../dms/UpdateInstancePojoFunctionalTest.java | 2 +
9 files changed, 76 insertions(+)
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/main/docs/hwcloud-dms-component.adoc
b/components/camel-huawei/camel-huaweicloud-dms/src/main/docs/hwcloud-dms-component.adoc
index 15dd17e..d3e0b59 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/main/docs/hwcloud-dms-component.adoc
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/main/docs/hwcloud-dms-component.adoc
@@ -160,6 +160,36 @@ with the following path and query parameters:
|`CamelHwCloudDmsInstanceId` |`String` | Instance ID to invoke operation on
+|`CamelHwCloudDmsName` |`String` | The name of the instance for creating and
updating an instance
+
+|`CamelHwCloudDmsEngineVersion` |`String` | The version of the message engine
+
+|`CamelHwCloudDmsSpecification` |`String` | The baseline bandwidth of a Kafka
instance
+
+|`CamelHwCloudDmsStorageSpace` |`int` | The message storage space
+
+|`CamelHwCloudDmsPartitionNum` |`int` | The maximum number of partitions in a
Kafka instance
+
+|`CamelHwCloudDmsAccessUser` |`String` | The username of a RabbitMQ instance
+
+|`CamelHwCloudDmsPassword` |`String` | The password of a RabbitMQ instance
+
+|`CamelHwCloudDmsVpcId` |`String` | The VPC ID
+
+|`CamelHwCloudDmsSecurityGroupId` |`String` | The security group which the
instance belongs to
+
+|`CamelHwCloudDmsSubnetId` |`String` | The subnet ID
+
+|`CamelHwCloudDmsAvailableZones` |`List<String>` | The ID of an available zone
+
+|`CamelHwCloudDmsProductId` |`String` | The product ID
+
+|`CamelHwCloudDmsKafkaManagerUser` |`String` | The username for logging in to
the Kafka Manager
+
+|`CamelHwCloudDmsKafkaManagerPassword` |`String` | The password for logging in
to the Kafka Manager
+
+|`CamelHwCloudDmsStorageSpecCode` |`String` | The storage I/O specification
+
|=======================================================================
If any of the above properties are set, they will override their corresponding
query parameter.
@@ -185,6 +215,40 @@ If any of the above properties are set, they will override
their corresponding q
- queryInstance
- updateInstance
+=== Create Instance
+To create an instance, you can pass the parameters through the endpoint, the
exchange properties, and the exchange body as a CreateInstanceRequestBody
object or a valid JSON String representation of it. Refer to this for the
https://support.huaweicloud.com/en-us/api-kafka/kafka-api-180514002.html[Kafka
parameters] and the
https://support.huaweicloud.com/en-us/api-rabbitmq/rabbitmq-api-180514002.html[RabbitMQ
parameters]. If you choose to pass these parameters through the endpoint or
thro [...]
+
+[source,java]
+----
+from("direct:triggerRoute")
+ .setBody(new
CreateInstanceRequestBody().withName("new-instance").withDescription("description").with*)
// add remaining options
+
.to("hwcloud-dms:createInstance?region=cn-north-4&authenticationKey=********&secretKey=********&projectId=*******")
+----
+
+[source,java]
+----
+from("direct:triggerRoute")
+ .setBody("{\"name\":\"new-instance\",\"description\":\"description\"}") //
add remaining options
+
.to("hwcloud-dms:createInstance?region=cn-north-4&authenticationKey=********&secretKey=********&projectId=*******")
+----
+
+=== Update Instance
+To update an instance, you must pass the parameters through the exchange body
as an UpdateInstanceRequestBody or a valid JSON String representation of it.
Refer to this for the
https://support.huaweicloud.com/en-us/api-kafka/kafka-api-180514004.html[Kafka
parameters] and the
https://support.huaweicloud.com/en-us/api-rabbitmq/rabbitmq-api-180514004.html[RabbitMQ
parameters]. An example of how to do this is shown below:
+
+[source,java]
+----
+from("direct:triggerRoute")
+ .setBody(new
UpdateInstanceRequestBody().withName("new-instance").withDescription("description").with*)
// add remaining options
+
.to("hwcloud-dms:updateInstance?instanceId=******®ion=cn-north-4&authenticationKey=********&secretKey=********&projectId=*******")
+----
+
+[source,java]
+----
+from("direct:triggerRoute")
+ .setBody("{\"name\":\"new-instance\",\"description\":\"description\"}") //
add remaining options
+
.to("hwcloud-dms:updateInstance?instanceId=******®ion=cn-north-4&authenticationKey=********&secretKey=********&projectId=*******")
+----
+
== Using ServiceKey Configuration Bean
Authentication key and secret keys are required to authenticate against cloud
DMS service. You can avoid having them being exposed
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceJsonFunctionalTest.java
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceJsonFunctionalTest.java
index 7bc93c3..c9a641a 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceJsonFunctionalTest.java
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceJsonFunctionalTest.java
@@ -63,6 +63,8 @@ public class CreateInstanceJsonFunctionalTest extends
CamelTestSupport {
MockEndpoint mock = getMockEndpoint("mock:operation_result");
mock.expectedMinimumMessageCount(1);
+ // new Kafka instance options:
https://support.huaweicloud.com/en-us/api-kafka/kafka-api-180514002.html
+ // new RabbitMQ instance options:
https://support.huaweicloud.com/en-us/api-rabbitmq/rabbitmq-api-180514002.html
String sampleBody = "{" +
"\"name\":\"" +
"replace_with_instance_information" + "\"," +
"\"description\":\"" +
"replace_with_instance_information" + "\"," +
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceKafkaFunctionalTest1.java
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceKafkaFunctionalTest1.java
index 2dc8be4..f4164e8 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceKafkaFunctionalTest1.java
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceKafkaFunctionalTest1.java
@@ -34,6 +34,7 @@ public class CreateInstanceKafkaFunctionalTest1 extends
CamelTestSupport {
private static final String PROJECT_ID = "replace_this_with_project_id";
private static final String REGION = "replace_this_with_region";
+ // new Kafka instance options:
https://support.huaweicloud.com/en-us/api-kafka/kafka-api-180514002.html
private static final String NAME = "replace_this_with_name";
private static final String ENGINE_VERSION =
"replace_this_with_engine_version";
private static final String SPECIFICATION =
"replace_this_with_specification";
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceKafkaFunctionalTest2.java
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceKafkaFunctionalTest2.java
index ad9c8cc..a355bb0 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceKafkaFunctionalTest2.java
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceKafkaFunctionalTest2.java
@@ -35,6 +35,7 @@ public class CreateInstanceKafkaFunctionalTest2 extends
CamelTestSupport {
private static final String PROJECT_ID = "replace_this_with_project_id";
private static final String REGION = "replace_this_with_region";
+ // new Kafka instance options:
https://support.huaweicloud.com/en-us/api-kafka/kafka-api-180514002.html
private static final String NAME = "replace_this_with_name";
private static final String ENGINE_VERSION =
"replace_this_with_engine_version";
private static final String SPECIFICATION =
"replace_this_with_specification";
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstancePojoFunctionalTest.java
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstancePojoFunctionalTest.java
index e836dc3..9ba92a4 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstancePojoFunctionalTest.java
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstancePojoFunctionalTest.java
@@ -67,6 +67,8 @@ public class CreateInstancePojoFunctionalTest extends
CamelTestSupport {
MockEndpoint mock = getMockEndpoint("mock:operation_result");
mock.expectedMinimumMessageCount(1);
+ // new Kafka instance options:
https://support.huaweicloud.com/en-us/api-kafka/kafka-api-180514002.html
+ // new RabbitMQ instance options:
https://support.huaweicloud.com/en-us/api-rabbitmq/rabbitmq-api-180514002.html
List<String> availableZones = new ArrayList<>();
availableZones.add("replace_with_instance_information");
CreateInstanceRequestBody sampleBody = new CreateInstanceRequestBody()
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceRmqFunctionalTest1.java
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceRmqFunctionalTest1.java
index 86a7edf..489135e 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceRmqFunctionalTest1.java
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceRmqFunctionalTest1.java
@@ -34,6 +34,7 @@ public class CreateInstanceRmqFunctionalTest1 extends
CamelTestSupport {
private static final String PROJECT_ID = "replace_this_with_project_id";
private static final String REGION = "replace_this_with_region";
+ // new RabbitMQ instance options:
https://support.huaweicloud.com/en-us/api-rabbitmq/rabbitmq-api-180514002.html
private static final String NAME = "replace_this_with_name";
private static final String ENGINE_VERSION =
"replace_this_with_engine_version";
private static final String STORAGE_SPACE =
"replace_this_with_storage_space";
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceRmqFunctionalTest2.java
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceRmqFunctionalTest2.java
index 75bddbf..d2d2785 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceRmqFunctionalTest2.java
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/CreateInstanceRmqFunctionalTest2.java
@@ -35,6 +35,7 @@ public class CreateInstanceRmqFunctionalTest2 extends
CamelTestSupport {
private static final String PROJECT_ID = "replace_this_with_project_id";
private static final String REGION = "replace_this_with_region";
+ // new RabbitMQ instance options:
https://support.huaweicloud.com/en-us/api-rabbitmq/rabbitmq-api-180514002.html
private static final String NAME = "replace_this_with_name";
private static final String ENGINE_VERSION =
"replace_this_with_engine_version";
private static final int STORAGE_SPACE = 0; //
replace_this_with_storage_space
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/UpdateInstanceJsonFunctionalTest.java
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/UpdateInstanceJsonFunctionalTest.java
index c27ba75..dba40c9 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/UpdateInstanceJsonFunctionalTest.java
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/UpdateInstanceJsonFunctionalTest.java
@@ -66,6 +66,8 @@ public class UpdateInstanceJsonFunctionalTest extends
CamelTestSupport {
MockEndpoint mock = getMockEndpoint("mock:operation_result");
mock.expectedMinimumMessageCount(1);
+ // Kafka instance options:
https://support.huaweicloud.com/en-us/api-kafka/kafka-api-180514004.html
+ // RabbitMQ instance options:
https://support.huaweicloud.com/en-us/api-rabbitmq/rabbitmq-api-180514004.html
String sampleBody = "{" +
"\"name\":\"" + "replace_with_new_information" +
"\"," +
"\"description\":\"" +
"replace_with_new_information" + "\"," +
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/UpdateInstancePojoFunctionalTest.java
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/UpdateInstancePojoFunctionalTest.java
index f4f9a78..f07b25c 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/UpdateInstancePojoFunctionalTest.java
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/test/java/org/apache/camel/component/huaweicloud/dms/UpdateInstancePojoFunctionalTest.java
@@ -67,6 +67,8 @@ public class UpdateInstancePojoFunctionalTest extends
CamelTestSupport {
MockEndpoint mock = getMockEndpoint("mock:operation_result");
mock.expectedMinimumMessageCount(1);
+ // Kafka instance options:
https://support.huaweicloud.com/en-us/api-kafka/kafka-api-180514004.html
+ // RabbitMQ instance options:
https://support.huaweicloud.com/en-us/api-rabbitmq/rabbitmq-api-180514004.html
UpdateInstanceRequestBody sampleBody = new UpdateInstanceRequestBody()
.withName("replace_with_new_information")
.withDescription("replace_with_new_information")
