You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2016/04/29 12:03:56 UTC

[2/2] camel git commit: Component docs. This closes #969

Component docs. This closes #969


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/a3f468c2
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/a3f468c2
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/a3f468c2

Branch: refs/heads/master
Commit: a3f468c27f7831249fce35403c47fe67ed8d8c16
Parents: 4c5b9c0
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Apr 29 12:03:46 2016 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Apr 29 12:03:46 2016 +0200

----------------------------------------------------------------------
 components/camel-flink/src/main/docs/flink.adoc | 44 ++++++++++++++++++++
 1 file changed, 44 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/a3f468c2/components/camel-flink/src/main/docs/flink.adoc
----------------------------------------------------------------------
diff --git a/components/camel-flink/src/main/docs/flink.adoc b/components/camel-flink/src/main/docs/flink.adoc
index 1660a66..d337530 100644
--- a/components/camel-flink/src/main/docs/flink.adoc
+++ b/components/camel-flink/src/main/docs/flink.adoc
@@ -37,6 +37,50 @@ flink:dataset?dataset=#myDataSet&dataSetCallback=#dataSetCallback
 flink:datastream?datastream=#myDataStream&dataStreamCallback=#dataStreamCallback
 -------------------------------------------------
 
+[[Flink-FlinkEndpointOptions]]
+FlinkEndpoint Options
+
+
+// endpoint options: START
+The Apache Flink component supports 8 endpoint options which are listed below:
+
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| endpointType | producer |  | EndpointType | *Required* Type of the endpoint (dataset datastream).
+| collect | producer | true | boolean | Indicates if results should be collected or counted.
+| dataSet | producer |  | DataSet | DataSet to compute against.
+| dataSetCallback | producer |  | DataSetCallback | Function performing action against a DataSet.
+| dataStream | producer |  | DataStream | DataStream to compute against.
+| dataStreamCallback | producer |  | DataStreamCallback | Function performing action against a DataStream.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+// endpoint options: END
+
+
+[[Flink-FlinkComponentOptions]]
+FlinkComponent Options
+^^^^^^^^^^^^^^^^^^^^
+
+
+// component options: START
+The Apache Flink component supports 4 options which are listed below.
+
+
+
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| dataSet | DataSet | DataSet to compute against.
+| dataStream | DataStream | DataStream to compute against.
+| dataSetCallback | DataSetCallback | Function performing action against a DataSet.
+| dataStreamCallback | DataStreamCallback | Function performing action against a DataStream.
+|=======================================================================
+// component options: END
+
+
+
 Flink DataSet Callback
 ^^^^^^^^^^^^^^^^^^^^^^