blob: 5bd046aa2c53f985f9eb038e558b72eed0a48d49 [file] [log] [blame]
{
"dataformat": {
"kind": "dataformat",
"name": "csv",
"title": "CSV",
"description": "Handle CSV (Comma Separated Values) payloads.",
"deprecated": false,
"firstVersion": "1.3.0",
"label": "dataformat,transformation,csv",
"javaType": "org.apache.camel.dataformat.csv.CsvDataFormat",
"supportLevel": "Stable",
"groupId": "org.apache.camel.springboot",
"artifactId": "camel-csv-starter",
"version": "3.11.0-SNAPSHOT",
"modelName": "csv",
"modelJavaType": "org.apache.camel.model.dataformat.CsvDataFormat"
},
"properties": {
"formatRef": { "kind": "attribute", "displayName": "Format Ref", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The reference format to use, it will be updated with the other format options, the default value is CSVFormat.DEFAULT" },
"formatName": { "kind": "attribute", "displayName": "Format Name", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "DEFAULT", "EXCEL", "INFORMIX_UNLOAD", "INFORMIX_UNLOAD_CSV", "MYSQL", "RFC4180" ], "deprecated": false, "autowired": false, "secret": false, "description": "The name of the format to use, the default value is CSVFormat.DEFAULT" },
"commentMarkerDisabled": { "kind": "attribute", "displayName": "Comment Marker Disabled", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Disables the comment marker of the reference format." },
"commentMarker": { "kind": "attribute", "displayName": "Comment Marker", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the comment marker of the reference format." },
"delimiter": { "kind": "attribute", "displayName": "Delimiter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the delimiter to use. The default value is , (comma)" },
"escapeDisabled": { "kind": "attribute", "displayName": "Escape Disabled", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Use for disabling using escape character" },
"escape": { "kind": "attribute", "displayName": "Escape", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the escape character to use" },
"headerDisabled": { "kind": "attribute", "displayName": "Header Disabled", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Use for disabling headers" },
"header": { "kind": "element", "displayName": "Header", "required": false, "type": "array", "javaType": "java.util.List<java.lang.String>", "deprecated": false, "autowired": false, "secret": false, "description": "To configure the CSV headers" },
"allowMissingColumnNames": { "kind": "attribute", "displayName": "Allow Missing Column Names", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether to allow missing column names." },
"ignoreEmptyLines": { "kind": "attribute", "displayName": "Ignore Empty Lines", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether to ignore empty lines." },
"ignoreSurroundingSpaces": { "kind": "attribute", "displayName": "Ignore Surrounding Spaces", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether to ignore surrounding spaces" },
"nullStringDisabled": { "kind": "attribute", "displayName": "Null String Disabled", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Used to disable null strings" },
"nullString": { "kind": "attribute", "displayName": "Null String", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the null string" },
"quoteDisabled": { "kind": "attribute", "displayName": "Quote Disabled", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Used to disable quotes" },
"quote": { "kind": "attribute", "displayName": "Quote", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the quote which by default is" },
"recordSeparatorDisabled": { "kind": "attribute", "displayName": "Record Separator Disabled", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Used for disabling record separator" },
"recordSeparator": { "kind": "attribute", "displayName": "Record Separator", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the record separator (aka new line) which by default is new line characters (CRLF)" },
"skipHeaderRecord": { "kind": "attribute", "displayName": "Skip Header Record", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether to skip the header record in the output" },
"quoteMode": { "kind": "attribute", "displayName": "Quote Mode", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the quote mode" },
"ignoreHeaderCase": { "kind": "attribute", "displayName": "Ignore Header Case", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Sets whether or not to ignore case when accessing header names." },
"trim": { "kind": "attribute", "displayName": "Trim", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Sets whether or not to trim leading and trailing blanks." },
"trailingDelimiter": { "kind": "attribute", "displayName": "Trailing Delimiter", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Sets whether or not to add a trailing delimiter." },
"marshallerFactoryRef": { "kind": "attribute", "displayName": "Marshaller Factory Ref", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the implementation of the CsvMarshallerFactory interface which is able to customize marshalling\/unmarshalling behavior by extending CsvMarshaller or creating it from scratch." },
"lazyLoad": { "kind": "attribute", "displayName": "Lazy Load", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one." },
"useMaps": { "kind": "attribute", "displayName": "Use Maps", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the unmarshalling should produce maps (HashMap)for the lines values instead of lists. It requires to have header (either defined or collected)." },
"useOrderedMaps": { "kind": "attribute", "displayName": "Use Ordered Maps", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the unmarshalling should produce ordered maps (LinkedHashMap) for the lines values instead of lists. It requires to have header (either defined or collected)." },
"recordConverterRef": { "kind": "attribute", "displayName": "Record Converter Ref", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Refers to a custom CsvRecordConverter to lookup from the registry to use." },
"captureHeaderRecord": { "kind": "attribute", "displayName": "Capture Header Record", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the unmarshalling should capture the header record and store it in the message header" },
"id": { "kind": "attribute", "displayName": "Id", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The id of this node" }
}
}