blob: 385f6960aebea67f934f0f569afbc62e12e09098 [file] [log] [blame]
{"component":{"kind":"component","name":"ignite-compute","title":"Ignite Compute","description":"Run compute operations on an Ignite cluster.","deprecated":false,"firstVersion":"2.17.0","label":"compute","javaType":"org.apache.camel.component.ignite.compute.IgniteComputeComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"3.18.1","scheme":"ignite-compute","extendsScheme":"","syntax":"ignite-compute:endpointId","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelIgniteComputeExecutionType":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.compute.IgniteComputeExecutionType","enum":["CALL","BROADCAST","APPLY","EXECUTE","RUN","AFFINITY_CALL","AFFINITY_RUN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the compute operation to perform.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_EXECUTION_TYPE"},"CamelIgniteComputeParameters":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Any object or Collection of objects","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Parameters for APPLY, BROADCAST and EXECUTE operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_PARAMS"},"CamelIgniteComputeReducer":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.ignite.lang.IgniteReducer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Reducer for the APPLY and CALL operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_REDUCER"},"CamelIgniteComputeAffinityCacheName":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Affinity cache name for the AFFINITY_CALL and AFFINITY_RUN operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_AFFINITY_CACHE_NAME"},"CamelIgniteComputeAffinityKey":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Affinity key for the AFFINITY_CALL and AFFINITY_RUN operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_COMPUTE_AFFINITY_KEY"}},"properties":{"endpointId":{"kind":"path","displayName":"Endpoint Id","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The endpoint ID (not used)."},"clusterGroupExpression":{"kind":"parameter","displayName":"Cluster Group Expression","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.ClusterGroupExpression","deprecated":false,"autowired":false,"secret":false,"description":"An expression that returns the Cluster Group for the IgniteCompute instance."},"computeName":{"kind":"parameter","displayName":"Compute Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the compute job, which will be set via IgniteCompute#withName(String)."},"executionType":{"kind":"parameter","displayName":"Execution Type","group":"producer","label":"producer","required":true,"type":"object","javaType":"org.apache.camel.component.ignite.compute.IgniteComputeExecutionType","enum":["CALL","BROADCAST","APPLY","EXECUTE","RUN","AFFINITY_CALL","AFFINITY_RUN"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The compute operation to perform. Possible values: CALL, BROADCAST, APPLY, EXECUTE, RUN, AFFINITY_CALL, AFFINITY_RUN. The component expects different payload types depending on the operation."},"propagateIncomingBodyIfNoReturnValue":{"kind":"parameter","displayName":"Propagate Incoming Body If No Return Value","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."},"taskName":{"kind":"parameter","displayName":"Task Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The task name, only applicable if using the IgniteComputeExecutionType#EXECUTE execution type."},"timeoutMillis":{"kind":"parameter","displayName":"Timeout Millis","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"The timeout interval for triggered jobs, in milliseconds, which will be set via IgniteCompute#withTimeout(long)."},"treatCollectionsAsCacheObjects":{"kind":"parameter","displayName":"Treat Collections As Cache Objects","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."},"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."}}}