| {"component":{"kind":"component","name":"timer","title":"Timer","description":"Generate messages in specified intervals using java.util.Timer.","deprecated":false,"firstVersion":"1.0.0","label":"core,scheduling","javaType":"org.apache.camel.component.timer.TimerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-timer","version":"3.18.1","scheme":"timer","extendsScheme":"","syntax":"timer:timerName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false},"headers":{"firedTime":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The fired time","constantName":"org.apache.camel.component.timer.TimerConstants#HEADER_FIRED_TIME"},"CamelMessageTimestamp":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.timer.TimerConstants#HEADER_MESSAGE_TIMESTAMP"}},"properties":{"timerName":{"kind":"path","displayName":"Timer Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the timer"},"delay":{"kind":"parameter","displayName":"Delay","group":"consumer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"Delay before first event is triggered."},"fixedRate":{"kind":"parameter","displayName":"Fixed Rate","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Events take place at approximately regular intervals, separated by the specified period."},"includeMetadata":{"kind":"parameter","displayName":"Include Metadata","group":"consumer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to include metadata in the exchange such as fired time, timer name, timer count etc. This information is default included."},"period":{"kind":"parameter","displayName":"Period","group":"consumer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1000","description":"If greater than 0, generate periodic events every period."},"repeatCount":{"kind":"parameter","displayName":"Repeat Count","group":"consumer","label":"","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the timer will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"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."},"daemon":{"kind":"parameter","displayName":"Daemon","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Specifies whether or not the thread associated with the timer endpoint runs as a daemon. The default value is true."},"pattern":{"kind":"parameter","displayName":"Pattern","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Allows you to specify a custom Date pattern to use for setting the time option using URI syntax."},"synchronous":{"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"time":{"kind":"parameter","displayName":"Time","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.util.Date","deprecated":false,"autowired":false,"secret":false,"description":"A java.util.Date the first event should be generated. If using the URI, the pattern expected is: yyyy-MM-dd HH:mm:ss or yyyy-MM-dd'T'HH:mm:ss."},"timer":{"kind":"parameter","displayName":"Timer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Timer","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom Timer"}}} |