blob: a0fdcd8a5edc61c3e999ce7a1c35abde93d0a32c [file] [log] [blame]
// kafka-connector options: START
[[camel-jclouds-kafka-connector-sink]]
= camel-jclouds-kafka-connector sink configuration
When using camel-jclouds-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-jclouds-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-jclouds sink connector supports 19 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.command* | What command to execute such as blobstore or compute. One of: [blobstore] [compute] | null | ConfigDef.Importance.HIGH
| *camel.sink.path.providerId* | The name of the cloud provider that provides the target service (e.g. aws-s3 or aws_ec2). | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.lazyStart Producer* | 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 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.blobName* | The name of the blob. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.container* | The name of the blob container. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.group* | The group that will be assigned to the newly created node. Values depend on the actual cloud provider. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.hardwareId* | The hardware that will be used for creating a node. Values depend on the actual cloud provider. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.imageId* | The imageId that will be used for creating a node. Values depend on the actual cloud provider. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.locationId* | The location that will be used for creating a node. Values depend on the actual cloud provider. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.nodeId* | The id of the node that will run the script or destroyed. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.nodeState* | To filter by node status to only select running nodes etc. One of: [PENDING] [TERMINATED] [SUSPENDED] [RUNNING] [ERROR] [UNRECOGNIZED] | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.operation* | Specifies the type of operation that will be performed to the blobstore. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.user* | The user on the target node that will run the script. | null | ConfigDef.Importance.MEDIUM
| *camel.component.jclouds.blob Stores* | To use the given BlobStore which must be configured when using blobstore. | null | ConfigDef.Importance.MEDIUM
| * camel.component.jclouds.compute Services* | To use the given ComputeService which must be configured when use compute. | null | ConfigDef.Importance.MEDIUM
| *camel.component.jclouds.lazy StartProducer* | 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 | ConfigDef.Importance.MEDIUM
| *camel.component.jclouds.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END