blob: fa3efb4e3cf0b6741e8c18a48a2f7008f6bdfc5f [file] [log] [blame]
{
"component": {
"kind": "component",
"name": "etcd3",
"title": "Etcd v3",
"description": "Get, set, delete or watch keys in etcd key-value store.",
"deprecated": false,
"firstVersion": "3.19.0",
"label": "clustering,database",
"javaType": "org.apache.camel.component.etcd3.Etcd3Component",
"supportLevel": "Preview",
"groupId": "org.apache.camel.springboot",
"artifactId": "camel-etcd3-starter",
"version": "3.22.0-SNAPSHOT",
"scheme": "etcd3",
"extendsScheme": "",
"syntax": "etcd3:path",
"async": false,
"api": false,
"consumerOnly": false,
"producerOnly": false,
"lenientProperties": false
},
"componentProperties": {
"configuration": { "kind": "property", "displayName": "Configuration", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.etcd3.Etcd3Configuration", "deprecated": false, "autowired": false, "secret": false, "description": "Component configuration." },
"endpoints": { "kind": "property", "displayName": "Endpoints", "group": "common", "label": "common", "required": false, "type": "array", "javaType": "java.lang.String[]", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "Etcd3Constants.ETCD_DEFAULT_ENDPOINTS", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure etcd server endpoints using the IPNameResolver." },
"keyCharset": { "kind": "property", "displayName": "Key Charset", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "UTF-8", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the charset to use for the keys." },
"namespace": { "kind": "property", "displayName": "Namespace", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the namespace of keys used. \/ will be treated as no namespace." },
"prefix": { "kind": "property", "displayName": "Prefix", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "To apply an action on all the key-value pairs whose key that starts with the target path." },
"bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "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." },
"fromIndex": { "kind": "property", "displayName": "From Index", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "The index to watch from" },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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." },
"valueCharset": { "kind": "property", "displayName": "Value Charset", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "UTF-8", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the charset to use for the values." },
"authHeaders": { "kind": "property", "displayName": "Auth Headers", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.String>", "prefix": "authHeaders.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the headers to be added to auth request headers." },
"authority": { "kind": "property", "displayName": "Authority", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the authority used to authenticate connections to servers." },
"autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." },
"connectionTimeout": { "kind": "property", "displayName": "Connection Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.time.Duration", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the connection timeout." },
"headers": { "kind": "property", "displayName": "Headers", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.String>", "prefix": "headers.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the headers to be added to http request headers." },
"keepAliveTime": { "kind": "property", "displayName": "Keep Alive Time", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.time.Duration", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "30 seconds", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the interval for gRPC keepalives. The current minimum allowed by gRPC is 10 seconds." },
"keepAliveTimeout": { "kind": "property", "displayName": "Keep Alive Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.time.Duration", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10 seconds", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the timeout for gRPC keepalives." },
"loadBalancerPolicy": { "kind": "property", "displayName": "Load Balancer Policy", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure etcd load balancer policy." },
"maxInboundMessageSize": { "kind": "property", "displayName": "Max Inbound Message Size", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the maximum message size allowed for a single gRPC frame." },
"retryDelay": { "kind": "property", "displayName": "Retry Delay", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the delay between retries in milliseconds." },
"retryMaxDelay": { "kind": "property", "displayName": "Retry Max Delay", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 2500, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the max backing off delay between retries in milliseconds." },
"retryMaxDuration": { "kind": "property", "displayName": "Retry Max Duration", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.time.Duration", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the retries max duration." },
"servicePath": { "kind": "property", "displayName": "Service Path", "group": "cloud", "label": "cloud", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "\/services\/", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "The path to look for service discovery." },
"password": { "kind": "property", "displayName": "Password", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure etcd auth password." },
"sslContext": { "kind": "property", "displayName": "Ssl Context", "group": "security", "label": "advanced,security", "required": false, "type": "object", "javaType": "io.netty.handler.ssl.SslContext", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure SSL\/TLS context to use instead of the system default." },
"userName": { "kind": "property", "displayName": "User Name", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure etcd auth user." }
},
"headers": {
"CamelEtcdAction": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The action to perform. Supported values: set get delete", "constantName": "org.apache.camel.component.etcd3.Etcd3Constants#ETCD_ACTION" },
"CamelEtcdPath": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The target path", "constantName": "org.apache.camel.component.etcd3.Etcd3Constants#ETCD_PATH" },
"CamelEtcdIsPrefix": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "To apply an action on all the key-value pairs whose key that starts with the target path.", "constantName": "org.apache.camel.component.etcd3.Etcd3Constants#ETCD_IS_PREFIX" },
"CamelEtcdKeyCharset": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The charset to use for the keys.", "constantName": "org.apache.camel.component.etcd3.Etcd3Constants#ETCD_KEY_CHARSET" },
"CamelEtcdValueCharset": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The charset to use for the values.", "constantName": "org.apache.camel.component.etcd3.Etcd3Constants#ETCD_VALUE_CHARSET" }
},
"properties": {
"path": { "kind": "path", "displayName": "Path", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The path the endpoint refers to" },
"endpoints": { "kind": "parameter", "displayName": "Endpoints", "group": "common", "label": "common", "required": false, "type": "array", "javaType": "java.lang.String[]", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "Etcd3Constants.ETCD_DEFAULT_ENDPOINTS", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure etcd server endpoints using the IPNameResolver." },
"keyCharset": { "kind": "parameter", "displayName": "Key Charset", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "UTF-8", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the charset to use for the keys." },
"namespace": { "kind": "parameter", "displayName": "Namespace", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the namespace of keys used. \/ will be treated as no namespace." },
"prefix": { "kind": "parameter", "displayName": "Prefix", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "To apply an action on all the key-value pairs whose key that starts with the target path." },
"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." },
"fromIndex": { "kind": "parameter", "displayName": "From Index", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "The index to watch from" },
"valueCharset": { "kind": "parameter", "displayName": "Value Charset", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "UTF-8", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the charset to use for the values." },
"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." },
"authHeaders": { "kind": "parameter", "displayName": "Auth Headers", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.String>", "prefix": "authHeaders.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the headers to be added to auth request headers." },
"authority": { "kind": "parameter", "displayName": "Authority", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the authority used to authenticate connections to servers." },
"connectionTimeout": { "kind": "parameter", "displayName": "Connection Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.time.Duration", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the connection timeout." },
"headers": { "kind": "parameter", "displayName": "Headers", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.String>", "prefix": "headers.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the headers to be added to http request headers." },
"keepAliveTime": { "kind": "parameter", "displayName": "Keep Alive Time", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.time.Duration", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "30 seconds", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the interval for gRPC keepalives. The current minimum allowed by gRPC is 10 seconds." },
"keepAliveTimeout": { "kind": "parameter", "displayName": "Keep Alive Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.time.Duration", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10 seconds", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the timeout for gRPC keepalives." },
"loadBalancerPolicy": { "kind": "parameter", "displayName": "Load Balancer Policy", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure etcd load balancer policy." },
"maxInboundMessageSize": { "kind": "parameter", "displayName": "Max Inbound Message Size", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the maximum message size allowed for a single gRPC frame." },
"retryDelay": { "kind": "parameter", "displayName": "Retry Delay", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the delay between retries in milliseconds." },
"retryMaxDelay": { "kind": "parameter", "displayName": "Retry Max Delay", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 2500, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the max backing off delay between retries in milliseconds." },
"retryMaxDuration": { "kind": "parameter", "displayName": "Retry Max Duration", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.time.Duration", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure the retries max duration." },
"servicePath": { "kind": "parameter", "displayName": "Service Path", "group": "cloud", "label": "cloud", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "\/services\/", "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "The path to look for service discovery." },
"password": { "kind": "parameter", "displayName": "Password", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure etcd auth password." },
"sslContext": { "kind": "parameter", "displayName": "Ssl Context", "group": "security", "label": "advanced,security", "required": false, "type": "object", "javaType": "io.netty.handler.ssl.SslContext", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure SSL\/TLS context to use instead of the system default." },
"userName": { "kind": "parameter", "displayName": "User Name", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.etcd3.Etcd3Configuration", "configurationField": "configuration", "description": "Configure etcd auth user." }
}
}