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 646f23b8ec81362d78ba9bb11de3d7467dc91c3e Author: Nicolas Filotto <[email protected]> AuthorDate: Mon Mar 21 15:07:18 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-flink --- .../resources/org/apache/camel/component/flink/flink.json | 6 ++++++ components/camel-flink/src/main/docs/flink-component.adoc | 4 +++- .../java/org/apache/camel/component/flink/FlinkConstants.java | 9 ++++++--- .../java/org/apache/camel/component/flink/FlinkEndpoint.java | 2 +- 4 files changed, 16 insertions(+), 5 deletions(-) diff --git a/components/camel-flink/src/generated/resources/org/apache/camel/component/flink/flink.json b/components/camel-flink/src/generated/resources/org/apache/camel/component/flink/flink.json index f41e472..08ce612 100644 --- a/components/camel-flink/src/generated/resources/org/apache/camel/component/flink/flink.json +++ b/components/camel-flink/src/generated/resources/org/apache/camel/component/flink/flink.json @@ -28,6 +28,12 @@ "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": { + "CamelFlinkDataSet": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The dataset" }, + "CamelFlinkDataSetCallback": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "org.apache.camel.component.flink.DataSetCallback", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The dataset callback" }, + "CamelFlinkDataStream": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The data stream" }, + "CamelFlinkDataStreamCallback": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "org.apache.camel.component.flink.DataStreamCallback", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The data stream callback" } + }, "properties": { "endpointType": { "kind": "path", "displayName": "Endpoint Type", "group": "producer", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.flink.EndpointType", "enum": [ "dataset", "datastream" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Type of the endpoint (dataset, datastream)." }, "collect": { "kind": "parameter", "displayName": "Collect", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Indicates if results should be collected or counted." }, diff --git a/components/camel-flink/src/main/docs/flink-component.adoc b/components/camel-flink/src/main/docs/flink-component.adoc index d8daa8a..bfb8ee0 100644 --- a/components/camel-flink/src/main/docs/flink-component.adoc +++ b/components/camel-flink/src/main/docs/flink-component.adoc @@ -56,7 +56,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 == Flink DataSet Callback diff --git a/components/camel-flink/src/main/java/org/apache/camel/component/flink/FlinkConstants.java b/components/camel-flink/src/main/java/org/apache/camel/component/flink/FlinkConstants.java index 29ae2b7..5816c34 100644 --- a/components/camel-flink/src/main/java/org/apache/camel/component/flink/FlinkConstants.java +++ b/components/camel-flink/src/main/java/org/apache/camel/component/flink/FlinkConstants.java @@ -16,14 +16,17 @@ */ package org.apache.camel.component.flink; +import org.apache.camel.spi.Metadata; + public final class FlinkConstants { + @Metadata(description = "The dataset", javaType = "Object") public static final String FLINK_DATASET_HEADER = "CamelFlinkDataSet"; - + @Metadata(description = "The dataset callback", javaType = "org.apache.camel.component.flink.DataSetCallback") public static final String FLINK_DATASET_CALLBACK_HEADER = "CamelFlinkDataSetCallback"; - + @Metadata(description = "The data stream", javaType = "Object") public static final String FLINK_DATASTREAM_HEADER = "CamelFlinkDataStream"; - + @Metadata(description = "The data stream callback", javaType = "org.apache.camel.component.flink.DataStreamCallback") public static final String FLINK_DATASTREAM_CALLBACK_HEADER = "CamelFlinkDataStreamCallback"; private FlinkConstants() { diff --git a/components/camel-flink/src/main/java/org/apache/camel/component/flink/FlinkEndpoint.java b/components/camel-flink/src/main/java/org/apache/camel/component/flink/FlinkEndpoint.java index 384beab..27c207e 100644 --- a/components/camel-flink/src/main/java/org/apache/camel/component/flink/FlinkEndpoint.java +++ b/components/camel-flink/src/main/java/org/apache/camel/component/flink/FlinkEndpoint.java @@ -32,7 +32,7 @@ import org.apache.flink.streaming.api.datastream.DataStream; * Send DataSet jobs to an Apache Flink cluster. */ @UriEndpoint(firstVersion = "2.18.0", scheme = "flink", title = "Flink", syntax = "flink:endpointType", producerOnly = true, - category = { Category.TRANSFORMATION, Category.BIGDATA, Category.STREAMS }) + category = { Category.TRANSFORMATION, Category.BIGDATA, Category.STREAMS }, headersClass = FlinkConstants.class) public class FlinkEndpoint extends DefaultEndpoint { @UriPath
