blob: 088e1655a2cb3808e54727f17b7634a993f1fa0c [file] [log] [blame]
{"component":{"kind":"component","name":"hazelcast-set","title":"Hazelcast Set","description":"Perform operations on Hazelcast distributed set.","deprecated":false,"firstVersion":"2.7.0","label":"cache,datagrid","javaType":"org.apache.camel.component.hazelcast.set.HazelcastSetComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"3.18.1","scheme":"hazelcast-set","extendsScheme":"","syntax":"hazelcast-set:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelHazelcastObjectId":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the object id to store / find your object inside the cache","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OBJECT_ID"},"CamelHazelcastListenerAction":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastCacheName":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache - e.g. foo","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#CACHE_NAME"},"CamelHazelcastOperationType":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#OPERATION"}},"properties":{"cacheName":{"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"kind":"parameter","displayName":"Default Operation","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastInstance":{"kind":"parameter","displayName":"Hazelcast Instance","group":"common","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"kind":"parameter","displayName":"Hazelcast Instance Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"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."}}}