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 193bf4777f1 CAMEL-18671: camel-dataset - Polished docs
193bf4777f1 is described below
commit 193bf4777f151588ba5e94bc30e31092527ea26a
Author: Claus Ibsen <[email protected]>
AuthorDate: Mon Oct 31 21:37:38 2022 +0100
CAMEL-18671: camel-dataset - Polished docs
---
.../org/apache/camel/catalog/components/dataset.json | 2 +-
.../org/apache/camel/component/dataset/dataset.json | 2 +-
.../org/apache/camel/component/dataset/DataSetEndpoint.java | 12 ++++++++----
3 files changed, 10 insertions(+), 6 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/dataset.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/dataset.json
index 44537377988..e7eb7025cf7 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/dataset.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/dataset.json
@@ -33,7 +33,7 @@
},
"properties": {
"name": { "kind": "path", "displayName": "Name", "group": "common",
"label": "", "required": true, "type": "object", "javaType":
"org.apache.camel.component.dataset.DataSet", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false, "description":
"Name of DataSet to lookup in the registry" },
- "dataSetIndex": { "kind": "parameter", "displayName": "Data Set Index",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "strict", "lenient", "off" ],
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"lenient", "description": "Controls the behaviour of the CamelDataSetIndex
header. For Consumers: - off = the header will not be set - strict\/lenient =
the header will be set For Producers: - off = th [...]
+ "dataSetIndex": { "kind": "parameter", "displayName": "Data Set Index",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "strict", "lenient", "off" ],
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"lenient", "description": "Controls the behaviour of the CamelDataSetIndex
header. off (consumer) the header will not be set. strict (consumer) the header
will be set. lenient (consumer) the header wil [...]
"initialDelay": { "kind": "parameter", "displayName": "Initial Delay",
"group": "consumer", "label": "consumer", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1000", "description": "Time period in millis
to wait before starting sending messages." },
"minRate": { "kind": "parameter", "displayName": "Min Rate", "group":
"consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 0, "description": "Wait until the DataSet contains at least
this number of messages" },
"preloadSize": { "kind": "parameter", "displayName": "Preload Size",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "long", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 0, "description": "Sets how many messages should be preloaded
(sent) before the route completes its initialization" },
diff --git
a/components/camel-dataset/src/generated/resources/org/apache/camel/component/dataset/dataset.json
b/components/camel-dataset/src/generated/resources/org/apache/camel/component/dataset/dataset.json
index 44537377988..e7eb7025cf7 100644
---
a/components/camel-dataset/src/generated/resources/org/apache/camel/component/dataset/dataset.json
+++
b/components/camel-dataset/src/generated/resources/org/apache/camel/component/dataset/dataset.json
@@ -33,7 +33,7 @@
},
"properties": {
"name": { "kind": "path", "displayName": "Name", "group": "common",
"label": "", "required": true, "type": "object", "javaType":
"org.apache.camel.component.dataset.DataSet", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false, "description":
"Name of DataSet to lookup in the registry" },
- "dataSetIndex": { "kind": "parameter", "displayName": "Data Set Index",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "strict", "lenient", "off" ],
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"lenient", "description": "Controls the behaviour of the CamelDataSetIndex
header. For Consumers: - off = the header will not be set - strict\/lenient =
the header will be set For Producers: - off = th [...]
+ "dataSetIndex": { "kind": "parameter", "displayName": "Data Set Index",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "strict", "lenient", "off" ],
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"lenient", "description": "Controls the behaviour of the CamelDataSetIndex
header. off (consumer) the header will not be set. strict (consumer) the header
will be set. lenient (consumer) the header wil [...]
"initialDelay": { "kind": "parameter", "displayName": "Initial Delay",
"group": "consumer", "label": "consumer", "required": false, "type":
"duration", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1000", "description": "Time period in millis
to wait before starting sending messages." },
"minRate": { "kind": "parameter", "displayName": "Min Rate", "group":
"consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 0, "description": "Wait until the DataSet contains at least
this number of messages" },
"preloadSize": { "kind": "parameter", "displayName": "Preload Size",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "long", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 0, "description": "Sets how many messages should be preloaded
(sent) before the route completes its initialization" },
diff --git
a/components/camel-dataset/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
b/components/camel-dataset/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
index 62399e15f94..8be279618d1 100644
---
a/components/camel-dataset/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
+++
b/components/camel-dataset/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
@@ -211,10 +211,14 @@ public class DataSetEndpoint extends MockEndpoint
implements Service {
}
/**
- * Controls the behaviour of the CamelDataSetIndex header. For Consumers:
- off => the header will not be set -
- * strict/lenient => the header will be set For Producers: - off => the
header value will not be verified, and will
- * not be set if it is not present = strict => the header value must be
present and will be verified = lenient =>
- * the header value will be verified if it is present, and will be set if
it is not present
+ * Controls the behaviour of the CamelDataSetIndex header.
+ *
+ * off (consumer) the header will not be set.
+ * strict (consumer) the header will be set.
+ * lenient (consumer) the header will be set.
+ * off (producer) the header value will not be verified, and will not be
set if it is not present.
+ * strict (producer) the header value must be present and will be verified.
+ * lenient (producer) the header value will be verified if it is present,
and will be set if it is not present.
*/
public void setDataSetIndex(String dataSetIndex) {
switch (dataSetIndex) {
