You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by nf...@apache.org on 2022/04/01 09:14:03 UTC

[camel] 03/18: CAMEL-17792: Add doc about the message headers of camel-kudu

This is an automated email from the ASF dual-hosted git repository.

nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 039c61449dca6aed1b538893f05392de1a97f2fb
Author: Nicolas Filotto <nf...@talend.com>
AuthorDate: Thu Mar 31 10:45:40 2022 +0200

    CAMEL-17792: Add doc about the message headers of camel-kudu
---
 .../src/generated/resources/org/apache/camel/component/kudu/kudu.json | 4 ++++
 components/camel-kudu/src/main/docs/kudu-component.adoc               | 4 +++-
 .../src/main/java/org/apache/camel/component/kudu/KuduConstants.java  | 4 ++++
 .../src/main/java/org/apache/camel/component/kudu/KuduEndpoint.java   | 3 ++-
 4 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/components/camel-kudu/src/generated/resources/org/apache/camel/component/kudu/kudu.json b/components/camel-kudu/src/generated/resources/org/apache/camel/component/kudu/kudu.json
index 1c09dc1c5..bfb4360 100644
--- a/components/camel-kudu/src/generated/resources/org/apache/camel/component/kudu/kudu.json
+++ b/components/camel-kudu/src/generated/resources/org/apache/camel/component/kudu/kudu.json
@@ -25,6 +25,10 @@
     "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 [...]
     "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 [...]
   },
+  "headers": {
+    "CamelKuduSchema": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "org.apache.kudu.Schema", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The schema" },
+    "CamelKuduTableOptions": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "org.apache.kudu.client.CreateTableOptions", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The create table options" }
+  },
   "properties": {
     "host": { "kind": "path", "displayName": "Host", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Host of the server to connect to" },
     "port": { "kind": "path", "displayName": "Port", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Port of the server to connect to" },
diff --git a/components/camel-kudu/src/main/docs/kudu-component.adoc b/components/camel-kudu/src/main/docs/kudu-component.adoc
index 7274f02..036818e 100644
--- a/components/camel-kudu/src/main/docs/kudu-component.adoc
+++ b/components/camel-kudu/src/main/docs/kudu-component.adoc
@@ -32,7 +32,9 @@ include::partial$component-endpoint-options.adoc[]
 // endpoint options: START
 
 // endpoint options: END
-
+// component headers: START
+include::partial$component-endpoint-headers.adoc[]
+// component headers: END
 
 == Input Body formats
 
diff --git a/components/camel-kudu/src/main/java/org/apache/camel/component/kudu/KuduConstants.java b/components/camel-kudu/src/main/java/org/apache/camel/component/kudu/KuduConstants.java
index fbc91d6..ebf4a60 100644
--- a/components/camel-kudu/src/main/java/org/apache/camel/component/kudu/KuduConstants.java
+++ b/components/camel-kudu/src/main/java/org/apache/camel/component/kudu/KuduConstants.java
@@ -16,8 +16,12 @@
  */
 package org.apache.camel.component.kudu;
 
+import org.apache.camel.spi.Metadata;
+
 public final class KuduConstants {
+    @Metadata(description = "The schema", javaType = "org.apache.kudu.Schema")
     public static final String CAMEL_KUDU_SCHEMA = "CamelKuduSchema";
+    @Metadata(description = "The create table options", javaType = "org.apache.kudu.client.CreateTableOptions")
     public static final String CAMEL_KUDU_TABLE_OPTIONS = "CamelKuduTableOptions";
 
     private KuduConstants() {
diff --git a/components/camel-kudu/src/main/java/org/apache/camel/component/kudu/KuduEndpoint.java b/components/camel-kudu/src/main/java/org/apache/camel/component/kudu/KuduEndpoint.java
index 42a3b74..afa11f9 100644
--- a/components/camel-kudu/src/main/java/org/apache/camel/component/kudu/KuduEndpoint.java
+++ b/components/camel-kudu/src/main/java/org/apache/camel/component/kudu/KuduEndpoint.java
@@ -38,7 +38,8 @@ import org.slf4j.LoggerFactory;
 @UriEndpoint(firstVersion = "3.0",
              scheme = "kudu",
              title = "Kudu", syntax = "kudu:host:port/tableName",
-             category = { Category.DATABASE, Category.IOT, Category.CLOUD }, producerOnly = true)
+             category = { Category.DATABASE, Category.IOT, Category.CLOUD }, producerOnly = true,
+             headersClass = KuduConstants.class)
 public class KuduEndpoint extends DefaultEndpoint {
 
     private static final Logger LOG = LoggerFactory.getLogger(KuduEndpoint.class);