| {"component":{"kind":"component","name":"controlbus","title":"Control Bus","description":"Manage and monitor Camel routes.","deprecated":false,"firstVersion":"2.11.0","label":"core,monitoring","javaType":"org.apache.camel.component.controlbus.ControlBusComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-controlbus","version":"3.18.1","scheme":"controlbus","extendsScheme":"","syntax":"controlbus:command:language","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"properties":{"command":{"kind":"path","displayName":"Command","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["route","language"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Command can be either route or language"},"language":{"kind":"path","displayName":"Language","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.spi.Language","enum":["bean","constant","el","exchangeProperty","file","groovy","header","jsonpath","mvel","ognl","ref","simple","spel","sql","terser","tokenize","xpath","xquery","xtokenize"],"deprecated":false,"autowired":false,"secret":false,"description":"Allows you to specify the name of a Language to use for evaluating the message body. If there is any result from the evaluation, then the result is put in the message body."},"action":{"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["start","stop","fail","suspend","resume","restart","status","stats"],"deprecated":false,"autowired":false,"secret":false,"description":"To denote an action that can be either: start, stop, or status. To either start or stop a route, or to get the status of the route as output in the message body. You can use suspend and resume to either suspend or resume a route. You can use stats to get performance statics returned in XML format; the routeId option can be used to define which route to get the performance stats for, if routeId is not defined, then you get statistics for the entire CamelContext. The restart action will restart the route. And the fail action will stop and mark the route as failed (stopped due to an exception)"},"async":{"kind":"parameter","displayName":"Async","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to execute the control bus task asynchronously. Important: If this option is enabled, then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously."},"loggingLevel":{"kind":"parameter","displayName":"Logging Level","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"INFO","description":"Logging level used for logging when task is done, or if any exceptions occurred during processing the task."},"restartDelay":{"kind":"parameter","displayName":"Restart Delay","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"The delay in millis to use when restarting a route."},"routeId":{"kind":"parameter","displayName":"Route Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To specify a route by its id. The special keyword current indicates the current route."},"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."}}} |