blob: 4c5f7b8dfbc2eb14fb57c95a168875ceb1726016 [file] [log] [blame]
{
"component": {
"kind": "component",
"name": "influxdb2",
"title": "InfluxDB2",
"description": "Interact with InfluxDB v2, a time series database.",
"deprecated": false,
"firstVersion": "3.20.0",
"label": "database",
"javaType": "org.apache.camel.component.influxdb2.InfluxDb2Component",
"supportLevel": "Stable",
"groupId": "org.apache.camel.springboot",
"artifactId": "camel-influxdb2-starter",
"version": "3.22.0-SNAPSHOT",
"scheme": "influxdb2",
"extendsScheme": "",
"syntax": "influxdb2:connectionBean",
"async": false,
"api": false,
"consumerOnly": false,
"producerOnly": true,
"lenientProperties": false
},
"componentProperties": {
"influxDBClient": { "kind": "property", "displayName": "Influx DBClient", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.influxdb.client.InfluxDBClient", "deprecated": false, "autowired": true, "secret": false, "description": "The shared Influx DB to use for all endpoints" },
"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." },
"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." }
},
"headers": {
"CamelInfluxDB2MeasurementName": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The name of measurement", "constantName": "org.apache.camel.component.influxdb2.InfluxDb2Constants#MEASUREMENT" },
"camelInfluxDB.RetentionPolicy": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The string that defines the retention policy to the data created by the endpoint", "constantName": "org.apache.camel.component.influxdb2.InfluxDb2Constants#RETENTION_POLICY" },
"CamelInfluxDB2WritePrecision": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "com.influxdb.client.domain.WritePrecision", "enum": [ "ms", "s", "us", "ns" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "InfluxDb Write precision.", "constantName": "org.apache.camel.component.influxdb2.InfluxDb2Constants#WRITE_PRECISION" }
},
"properties": {
"connectionBean": { "kind": "path", "displayName": "Connection Bean", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Connection to the Influx database, of class com.influxdb.client.InfluxDBClient.class." },
"autoCreateBucket": { "kind": "parameter", "displayName": "Auto Create Bucket", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Define if we want to auto create the bucket if it's not present." },
"autoCreateOrg": { "kind": "parameter", "displayName": "Auto Create Org", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Define if we want to auto create the organization if it's not present." },
"bucket": { "kind": "parameter", "displayName": "Bucket", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The name of the bucket where the time series will be stored." },
"operation": { "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.influxdb2.enums.Operation", "enum": [ "INSERT", "PING" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "INSERT", "description": "Define if this operation is an insert of ping." },
"org": { "kind": "parameter", "displayName": "Org", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The name of the organization where the time series will be stored." },
"retentionPolicy": { "kind": "parameter", "displayName": "Retention Policy", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "default", "description": "Define the retention policy to the data created by the endpoint." },
"writePrecision": { "kind": "parameter", "displayName": "Write Precision", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.influxdb.client.domain.WritePrecision", "enum": [ "ms", "s", "us", "ns" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "ms", "description": "The format or precision of time series timestamps." },
"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." }
}
}