blob: a038c62e97f029d8cfbaede62c13f2063fec0c06 [file] [log] [blame]
// kafka-connector options: START
[[camel-fhir-kafka-connector-sink]]
= camel-fhir-kafka-connector sink configuration
When using camel-fhir-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-fhir-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-fhir sink connector supports 32 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.apiName* | What kind of operation to perform One of: [capabilities] [create] [delete] [history] [load-page] [meta] [patch] [read] [search] [transaction] [update] [validate] | null | ConfigDef.Importance.HIGH
| *camel.sink.path.methodName* | What sub operation to use for the selected operation | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.encoding* | Encoding to use for all request One of: [JSON] [XML] | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.fhir Version* | The FHIR Version to use One of: [DSTU2] [DSTU2_HL7ORG] [DSTU2_1] [DSTU3] [R4] [R5] | "R4" | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.inBody* | Sets the name of a parameter to be passed in the exchange In Body | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.log* | Will log every requests and responses | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.pretty Print* | Pretty print all request | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.serverUrl* | The FHIR server base URL | null | ConfigDef.Importance.MEDIUM
| *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.client* | To use the custom client | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.client Factory* | To use the custom client factory | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.compress* | Compresses outgoing (POST/PUT) contents to the GZIP format | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.connection Timeout* | How long to try and establish the initial TCP connection (in ms) | "10000" | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.deferModel Scanning* | When this option is set, model classes will not be scanned for children until the child list for the given type is actually accessed. | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.fhir Context* | FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.force ConformanceCheck* | Force conformance check | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.session Cookie* | HTTP session cookie to add to every request | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.socket Timeout* | How long to block for individual read/write operations (in ms) | "10000" | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.summary* | Request that the server modify the response using the _summary param One of: [COUNT] [TEXT] [DATA] [TRUE] [FALSE] | null | 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.validation Mode* | When should Camel validate the FHIR Server's conformance statement One of: [NEVER] [ONCE] | "ONCE" | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.proxyHost* | The proxy host | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.proxy Password* | The proxy password | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.proxyPort* | The proxy port | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.proxyUser* | The proxy username | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.access Token* | OAuth access token | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.password* | Username to use for basic authentication | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.username* | Username to use for basic authentication | null | ConfigDef.Importance.MEDIUM
| * camel.component.fhir.configuration* | To use the shared configuration | null | ConfigDef.Importance.MEDIUM
| *camel.component.fhir.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.component.fhir.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