blob: 73e1e9a82e7de53c4bd6353bf6dc2df60194e872 [file] [log] [blame]
{"component":{"kind":"component","name":"ignite-queue","title":"Ignite Queues","description":"Interact with Ignite Queue data structures.","deprecated":false,"firstVersion":"2.17.0","label":"messaging,queue","javaType":"org.apache.camel.component.ignite.queue.IgniteQueueComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-ignite","version":"3.18.1","scheme":"ignite-queue","extendsScheme":"","syntax":"ignite-queue:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelIgniteQueueOperation":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.ignite.queue.IgniteQueueOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY","DRAIN","ELEMENT","PEEK","OFFER","POLL","TAKE","PUT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Allows you to dynamically change the queue operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_OPERATION"},"CamelIgniteQueueMaxElements":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"When invoking the DRAIN operation, the amount of items to drain.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_MAX_ELEMENTS"},"CamelIgniteQueueTransferredCount":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The amount of items transferred as the result of the DRAIN operation.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_TRANSFERRED_COUNT"},"CamelIgniteQueueTimeoutMillis":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Dynamically sets the timeout in milliseconds to use when invoking the OFFER or POLL operations.","constantName":"org.apache.camel.component.ignite.IgniteConstants#IGNITE_QUEUE_TIMEOUT_MILLIS"}},"properties":{"name":{"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The queue name."},"capacity":{"kind":"parameter","displayName":"Capacity","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The queue capacity. Default: non-bounded."},"configuration":{"kind":"parameter","displayName":"Configuration","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ignite.configuration.CollectionConfiguration","deprecated":false,"autowired":false,"secret":false,"description":"The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options."},"operation":{"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.ignite.queue.IgniteQueueOperation","enum":["CONTAINS","ADD","SIZE","REMOVE","ITERATOR","CLEAR","RETAIN_ALL","ARRAY","DRAIN","ELEMENT","PEEK","OFFER","POLL","TAKE","PUT"],"deprecated":false,"autowired":false,"secret":false,"description":"The operation to invoke on the Ignite Queue. Superseded by the IgniteConstants.IGNITE_QUEUE_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY, DRAIN, ELEMENT, PEEK, OFFER, POLL, TAKE, PUT."},"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."},"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 queue timeout in milliseconds. Default: no timeout."},"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."}}}