blob: 55357a1a47d2078caa9860602d79e61384ed2f2b [file] [log] [blame]
// kafka-connector options: START
[[camel-digitalocean-kafka-connector-sink]]
= camel-digitalocean-kafka-connector sink configuration
When using camel-digitalocean-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-digitalocean-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-digitalocean sink connector supports 15 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.operation* | The operation to perform to the given resource. One of: [create] [update] [delete] [list] [ownList] [get] [listBackups] [listActions] [listNeighbors] [listSnapshots] [listKernels] [listAllNeighbors] [enableBackups] [disableBackups] [reboot] [powerCycle] [shutdown] [powerOn] [powerOff] [restore] [resetPassword] [resize] [rebuild] [rename] [changeKernel] [enableIpv6] [enablePrivateNetworking] [takeSnapshot] [transfer] [convert] [attach] [detach] [assign] [unassign] [tag] [untag] | null | MEDIUM
| *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 | MEDIUM
| *camel.sink.endpoint.page* | Use for pagination. Force the page number. | "1" | MEDIUM
| *camel.sink.endpoint.perPage* | Use for pagination. Set the number of item per request. The maximum number of results per page is 200. | "25" | MEDIUM
| *camel.sink.endpoint.resource* | The DigitalOcean resource type on which perform the operation. One of: [account] [actions] [blockStorages] [droplets] [mages] [snapshots] [keys] [regions] [sizes] [floatingIPs] [tags] | null | HIGH
| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.sink.endpoint.digitalOceanClient* | To use a existing configured DigitalOceanClient as client | null | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.httpProxyHost* | Set a proxy host if needed | null | MEDIUM
| *camel.sink.endpoint.httpProxyPassword* | Set a proxy password if needed | null | MEDIUM
| *camel.sink.endpoint.httpProxyPort* | Set a proxy port if needed | null | MEDIUM
| *camel.sink.endpoint.httpProxyUser* | Set a proxy host if needed | null | MEDIUM
| *camel.sink.endpoint.oAuthToken* | DigitalOcean OAuth Token | null | MEDIUM
| *camel.component.digitalocean.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 | MEDIUM
| *camel.component.digitalocean.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
|===
// kafka-connector options: END