blob: 2bf6def0036559097b59c30afd0a9dc815fafa48 [file] [log] [blame]
// kafka-connector options: START
[[camel-ipfs-kafka-connector-sink]]
= camel-ipfs-kafka-connector sink configuration
Connector Description: Access the Interplanetary File System (IPFS).
When using camel-ipfs-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-ipfs-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
To use this Sink connector in Kafka connect you'll need to set the following connector.class
[source,java]
----
connector.class=org.apache.camel.kafkaconnector.ipfs.CamelIpfsSinkConnector
----
The camel-ipfs sink connector supports 7 options, which are listed below.
[width="100%",cols="2,5,^1,1,1",options="header"]
|===
| Name | Description | Default | Required | Priority
| *camel.sink.path.ipfsCmd* | The ipfs command One of: [add] [cat] [get] [version] | null | true | HIGH
| *camel.sink.endpoint.lazyStartProducer* | 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. | false | false | MEDIUM
| *camel.sink.endpoint.outdir* | The ipfs output directory | null | false | MEDIUM
| *camel.component.ipfs.ipfsHost* | The ipfs host | "127.0.0.1" | false | MEDIUM
| *camel.component.ipfs.ipfsPort* | The ipfs port | 5001 | false | MEDIUM
| *camel.component.ipfs.lazyStartProducer* | 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. | false | false | MEDIUM
| *camel.component.ipfs.autowiredEnabled* | 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. | true | false | MEDIUM
|===
The camel-ipfs sink connector has no converters out of the box.
The camel-ipfs sink connector has no transforms out of the box.
The camel-ipfs sink connector has no aggregation strategies out of the box.
// kafka-connector options: END