blob: 69d7bc6091e47a6ede5c8919a65240eb23c76bd1 [file] [log] [blame]
{"component":{"kind":"component","name":"flink","title":"Flink","description":"Send DataSet jobs to an Apache Flink cluster.","deprecated":false,"firstVersion":"2.18.0","label":"transformation,bigdata,streams","javaType":"org.apache.camel.component.flink.FlinkComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-flink","version":"3.18.1","scheme":"flink","extendsScheme":"","syntax":"flink:endpointType","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelFlinkDataSet":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The dataset","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASET_HEADER"},"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","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASET_CALLBACK_HEADER"},"CamelFlinkDataStream":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The data stream","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASTREAM_HEADER"},"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","constantName":"org.apache.camel.component.flink.FlinkConstants#FLINK_DATASTREAM_CALLBACK_HEADER"}},"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."},"dataSet":{"kind":"parameter","displayName":"Data Set","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.flink.api.java.DataSet","deprecated":false,"autowired":false,"secret":false,"description":"DataSet to compute against."},"dataSetCallback":{"kind":"parameter","displayName":"Data Set Callback","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.flink.DataSetCallback","deprecated":false,"autowired":false,"secret":false,"description":"Function performing action against a DataSet."},"dataStream":{"kind":"parameter","displayName":"Data Stream","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.flink.streaming.api.datastream.DataStream","deprecated":false,"autowired":false,"secret":false,"description":"DataStream to compute against."},"dataStreamCallback":{"kind":"parameter","displayName":"Data Stream Callback","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.flink.DataStreamCallback","deprecated":false,"autowired":false,"secret":false,"description":"Function performing action against a DataStream."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","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 starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."}}}