blob: d4b1f34b3bb03669084f2247b433787f4ef8870c [file] [log] [blame]
// kafka-connector options: START
[[camel-milo-client-kafka-connector-sink]]
= camel-milo-client-kafka-connector sink configuration
When using camel-milo-client-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-milo-client-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-milo-client sink connector supports 34 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.endpointUri* | The OPC UA server endpoint | null | HIGH
| *camel.sink.endpoint.clientId* | A virtual client id to force the creation of a new connection instance | null | MEDIUM
| *camel.sink.endpoint.defaultAwaitWrites* | Default await setting for writes | false | MEDIUM
| *camel.sink.endpoint.discoveryEndpointSuffix* | A suffix for endpoint URI when discovering | null | MEDIUM
| *camel.sink.endpoint.discoveryEndpointUri* | An alternative discovery URI | null | MEDIUM
| *camel.sink.endpoint.method* | The method definition (see Method ID) | null | MEDIUM
| *camel.sink.endpoint.node* | The node definition (see Node ID) | null | MEDIUM
| *camel.sink.endpoint.samplingInterval* | The sampling interval in milliseconds | 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.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.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.allowedSecurityPolicies* | A set of allowed security policy URIs. Default is to accept all and use the highest. | null | MEDIUM
| *camel.sink.endpoint.applicationName* | The application name | "Apache Camel adapter for Eclipse Milo" | MEDIUM
| *camel.sink.endpoint.applicationUri* | The application URI | "http://camel.apache.org/EclipseMilo/Client" | MEDIUM
| *camel.sink.endpoint.channelLifetime* | Channel lifetime in milliseconds | null | MEDIUM
| *camel.sink.endpoint.keyAlias* | The name of the key in the keystore file | null | MEDIUM
| *camel.sink.endpoint.keyPassword* | The key password | null | MEDIUM
| *camel.sink.endpoint.keyStorePassword* | The keystore password | null | MEDIUM
| *camel.sink.endpoint.keyStoreType* | The key store type | null | MEDIUM
| *camel.sink.endpoint.keyStoreUrl* | The URL where the key should be loaded from | null | MEDIUM
| *camel.sink.endpoint.maxPendingPublishRequests* | The maximum number of pending publish requests | null | MEDIUM
| *camel.sink.endpoint.maxResponseMessageSize* | The maximum number of bytes a response message may have | null | MEDIUM
| *camel.sink.endpoint.overrideHost* | Override the server reported endpoint host with the host from the endpoint URI. | false | MEDIUM
| *camel.sink.endpoint.productUri* | The product URI | "http://camel.apache.org/EclipseMilo" | MEDIUM
| *camel.sink.endpoint.requestTimeout* | Request timeout in milliseconds | null | MEDIUM
| *camel.sink.endpoint.sessionName* | Session name | null | MEDIUM
| *camel.sink.endpoint.sessionTimeout* | Session timeout in milliseconds | null | MEDIUM
| *camel.component.milo-client.applicationName* | Default application name | null | MEDIUM
| *camel.component.milo-client.applicationUri* | Default application URI | null | MEDIUM
| *camel.component.milo-client.defaultConfiguration* | All default options for client | null | MEDIUM
| *camel.component.milo-client.productUri* | Default product URI | null | MEDIUM
| *camel.component.milo-client.reconnectTimeout* | Default reconnect timeout | null | MEDIUM
| *camel.component.milo-client.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.milo-client.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