Chapter 107. Apache Flink Component
Available as of Camel version 2.18
This documentation page covers the Apache Flink component for the Apache Camel. The camel-flink component provides a bridge between Camel connectors and Flink tasks.
This Camel Flink connector provides a way to route message from various transports, dynamically choosing a flink task to execute, use incoming message as input data for the task and finally deliver the results back to the Camel pipeline.
Maven users will need to add the following dependency to their pom.xml
for this component:
107.1. URI Format Copy linkLink copied to clipboard!
Currently, the Flink Component supports only Producers. One can create DataSet, DataStream jobs.
flink:dataset?dataset=#myDataSet&dataSetCallback=#dataSetCallback flink:datastream?datastream=#myDataStream&dataStreamCallback=#dataStreamCallback
flink:dataset?dataset=#myDataSet&dataSetCallback=#dataSetCallback
flink:datastream?datastream=#myDataStream&dataStreamCallback=#dataStreamCallback
FlinkEndpoint Options
The Apache Flink endpoint is configured using URI syntax:
flink:endpointType
flink:endpointType
with the following path and query parameters:
107.1.1. Path Parameters (1 parameters): Copy linkLink copied to clipboard!
Name | Description | Default | Type |
---|---|---|---|
endpointType | Required Type of the endpoint (dataset, datastream). | EndpointType |
107.1.2. Query Parameters (6 parameters): Copy linkLink copied to clipboard!
Name | Description | Default | Type |
---|---|---|---|
collect (producer) | Indicates if results should be collected or counted. | true | boolean |
dataSet (producer) | DataSet to compute against. | DataSet | |
dataSetCallback (producer) | Function performing action against a DataSet. | DataSetCallback | |
dataStream (producer) | DataStream to compute against. | DataStream | |
dataStreamCallback (producer) | Function performing action against a DataStream. | DataStreamCallback | |
synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
107.2. FlinkComponent Options Copy linkLink copied to clipboard!
The Apache Flink component supports 5 options which are listed below.
Name | Description | Default | Type |
---|---|---|---|
dataSet (producer) | DataSet to compute against. | DataSet | |
dataStream (producer) | DataStream to compute against. | DataStream | |
dataSetCallback (producer) | Function performing action against a DataSet. | DataSetCallback | |
dataStreamCallback (producer) | Function performing action against a DataStream. | DataStreamCallback | |
resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
107.3. Flink DataSet Callback Copy linkLink copied to clipboard!
107.4. Flink DataStream Callback Copy linkLink copied to clipboard!
107.5. Camel-Flink Producer call Copy linkLink copied to clipboard!
107.6. See Also Copy linkLink copied to clipboard!
- Configuring Camel
- Component
- Endpoint
- Getting Started