camel-kafka-connector-catalog/src/generated/resources/connectors/camel-hdfs-sink.json

{
	"connector": {
		"class": "org.apache.camel.kafkaconnector.hdfs.CamelHdfsSinkConnector",
		"artifactId": "camel-hdfs-kafka-connector",
		"groupId": "org.apache.camel.kafkaconnector",
		"id": "camel-hdfs-sink",
		"type": "sink",
		"version": "0.7.3",
		"description": "Read and write from\/to an HDFS filesystem using Hadoop 2.x."
	},
	"properties": {
		"camel.sink.path.hostName": {
			"name": "camel.sink.path.hostName",
			"description": "HDFS host to use",
			"priority": "HIGH",
			"required": "true"
		},
		"camel.sink.path.port": {
			"name": "camel.sink.path.port",
			"description": "HDFS port to use",
			"defaultValue": "8020",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.path.path": {
			"name": "camel.sink.path.path",
			"description": "The directory path to use",
			"priority": "HIGH",
			"required": "true"
		},
		"camel.sink.endpoint.connectOnStartup": {
			"name": "camel.sink.endpoint.connectOnStartup",
			"description": "Whether to connect to the HDFS file system on starting the producer\/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection, as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup, and not block for up till 15 minutes.",
			"defaultValue": "true",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.fileSystemType": {
			"name": "camel.sink.endpoint.fileSystemType",
			"description": "Set to LOCAL to not use HDFS but local java.io.File instead. One of: [LOCAL] [HDFS]",
			"defaultValue": "\"HDFS\"",
			"priority": "MEDIUM",
			"required": "false",
			"enum": [
				"LOCAL",
				"HDFS"
			]
		},
		"camel.sink.endpoint.fileType": {
			"name": "camel.sink.endpoint.fileType",
			"description": "The file type to use. For more details see Hadoop HDFS documentation about the various files types. One of: [NORMAL_FILE] [SEQUENCE_FILE] [MAP_FILE] [BLOOMMAP_FILE] [ARRAY_FILE]",
			"defaultValue": "\"NORMAL_FILE\"",
			"priority": "MEDIUM",
			"required": "false",
			"enum": [
				"NORMAL_FILE",
				"SEQUENCE_FILE",
				"MAP_FILE",
				"BLOOMMAP_FILE",
				"ARRAY_FILE"
			]
		},
		"camel.sink.endpoint.keyType": {
			"name": "camel.sink.endpoint.keyType",
			"description": "The type for the key in case of sequence or map files. One of: [NULL] [BOOLEAN] [BYTE] [INT] [FLOAT] [LONG] [DOUBLE] [TEXT] [BYTES]",
			"defaultValue": "\"NULL\"",
			"priority": "MEDIUM",
			"required": "false",
			"enum": [
				"NULL",
				"BOOLEAN",
				"BYTE",
				"INT",
				"FLOAT",
				"LONG",
				"DOUBLE",
				"TEXT",
				"BYTES"
			]
		},
		"camel.sink.endpoint.namedNodes": {
			"name": "camel.sink.endpoint.namedNodes",
			"description": "A comma separated list of named nodes (e.g. srv11.example.com:8020,srv12.example.com:8020)",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.owner": {
			"name": "camel.sink.endpoint.owner",
			"description": "The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.valueType": {
			"name": "camel.sink.endpoint.valueType",
			"description": "The type for the key in case of sequence or map files One of: [NULL] [BOOLEAN] [BYTE] [INT] [FLOAT] [LONG] [DOUBLE] [TEXT] [BYTES]",
			"defaultValue": "\"BYTES\"",
			"priority": "MEDIUM",
			"required": "false",
			"enum": [
				"NULL",
				"BOOLEAN",
				"BYTE",
				"INT",
				"FLOAT",
				"LONG",
				"DOUBLE",
				"TEXT",
				"BYTES"
			]
		},
		"camel.sink.endpoint.append": {
			"name": "camel.sink.endpoint.append",
			"description": "Append to existing file. Notice that not all HDFS file systems support the append option.",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.lazyStartProducer": {
			"name": "camel.sink.endpoint.lazyStartProducer",
			"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.",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.overwrite": {
			"name": "camel.sink.endpoint.overwrite",
			"description": "Whether to overwrite existing files with the same name",
			"defaultValue": "true",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.blockSize": {
			"name": "camel.sink.endpoint.blockSize",
			"description": "The size of the HDFS blocks",
			"defaultValue": "67108864L",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.bufferSize": {
			"name": "camel.sink.endpoint.bufferSize",
			"description": "The buffer size used by HDFS",
			"defaultValue": "4096",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.checkIdleInterval": {
			"name": "camel.sink.endpoint.checkIdleInterval",
			"description": "How often (time in millis) in to run the idle checker background task. This option is only in use if the splitter strategy is IDLE.",
			"defaultValue": "500",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.chunkSize": {
			"name": "camel.sink.endpoint.chunkSize",
			"description": "When reading a normal file, this is split into chunks producing a message per chunk.",
			"defaultValue": "4096",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.compressionCodec": {
			"name": "camel.sink.endpoint.compressionCodec",
			"description": "The compression codec to use One of: [DEFAULT] [GZIP] [BZIP2]",
			"defaultValue": "\"DEFAULT\"",
			"priority": "MEDIUM",
			"required": "false",
			"enum": [
				"DEFAULT",
				"GZIP",
				"BZIP2"
			]
		},
		"camel.sink.endpoint.compressionType": {
			"name": "camel.sink.endpoint.compressionType",
			"description": "The compression type to use (is default not in use) One of: [NONE] [RECORD] [BLOCK]",
			"defaultValue": "\"NONE\"",
			"priority": "MEDIUM",
			"required": "false",
			"enum": [
				"NONE",
				"RECORD",
				"BLOCK"
			]
		},
		"camel.sink.endpoint.openedSuffix": {
			"name": "camel.sink.endpoint.openedSuffix",
			"description": "When a file is opened for reading\/writing the file is renamed with this suffix to avoid to read it during the writing phase.",
			"defaultValue": "\"opened\"",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.readSuffix": {
			"name": "camel.sink.endpoint.readSuffix",
			"description": "Once the file has been read is renamed with this suffix to avoid to read it again.",
			"defaultValue": "\"read\"",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.replication": {
			"name": "camel.sink.endpoint.replication",
			"description": "The HDFS replication factor",
			"defaultValue": "3",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.splitStrategy": {
			"name": "camel.sink.endpoint.splitStrategy",
			"description": "In the current version of Hadoop opening a file in append mode is disabled since it's not very reliable. So, for the moment, it's only possible to create new files. The Camel HDFS endpoint tries to solve this problem in this way: If the split strategy option has been defined, the hdfs path will be used as a directory and files will be created using the configured UuidGenerator. Every time a splitting condition is met, a new file is created. The splitStrategy option is defined as a string with the following syntax: splitStrategy=ST:value,ST:value,... where ST can be: BYTES a new file is created, and the old is closed when the number of written bytes is more than value MESSAGES a new file is created, and the old is closed when the number of written messages is more than value IDLE a new file is created, and the old is closed when no writing happened in the last value milliseconds",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.synchronous": {
			"name": "camel.sink.endpoint.synchronous",
			"description": "Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.kerberosConfigFileLocation": {
			"name": "camel.sink.endpoint.kerberosConfigFileLocation",
			"description": "The location of the kerb5.conf file (https:\/\/web.mit.edu\/kerberos\/krb5-1.12\/doc\/admin\/conf_files\/krb5_conf.html)",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.kerberosKeytabLocation": {
			"name": "camel.sink.endpoint.kerberosKeytabLocation",
			"description": "The location of the keytab file used to authenticate with the kerberos nodes (contains pairs of kerberos principals and encrypted keys (which are derived from the Kerberos password))",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.sink.endpoint.kerberosUsername": {
			"name": "camel.sink.endpoint.kerberosUsername",
			"description": "The username used to authenticate with the kerberos nodes",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.hdfs.lazyStartProducer": {
			"name": "camel.component.hdfs.lazyStartProducer",
			"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.",
			"defaultValue": "false",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.hdfs.autowiredEnabled": {
			"name": "camel.component.hdfs.autowiredEnabled",
			"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.",
			"defaultValue": "true",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.hdfs.jAASConfiguration": {
			"name": "camel.component.hdfs.jAASConfiguration",
			"description": "To use the given configuration for security with JAAS.",
			"priority": "MEDIUM",
			"required": "false"
		},
		"camel.component.hdfs.kerberosConfigFile": {
			"name": "camel.component.hdfs.kerberosConfigFile",
			"description": "To use kerberos authentication, set the value of the 'java.security.krb5.conf' environment variable to an existing file. If the environment variable is already set, warn if different than the specified parameter",
			"priority": "MEDIUM",
			"required": "false"
		}
	}
}