| // kafka-connector options: START |
| [[camel-workday-kafka-connector-sink]] |
| = camel-workday-kafka-connector sink configuration |
| |
| When using camel-workday-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-workday-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-workday sink connector supports 14 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.entity* | The entity to be requested or subscribed via API. One of: [report] | null | HIGH |
| | *camel.sink.path.path* | The API path to access an entity structure. | null | 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 | 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.httpConnectionManager* | Pool connection manager for advanced configuration. | 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.reportFormat* | Workday Report as a service output format. One of: [json] | "json" | MEDIUM |
| | *camel.sink.endpoint.host* | Workday Host name. | null | HIGH |
| | *camel.sink.endpoint.clientId* | Workday client Id generated by API client for integrations. | null | HIGH |
| | *camel.sink.endpoint.clientSecret* | Workday client Secret generated by API client for integrations. | null | HIGH |
| | *camel.sink.endpoint.tokenRefresh* | Workday token Refresh generated for integrations system user. | null | HIGH |
| | *camel.sink.endpoint.tenant* | Workday Tenant name. | null | HIGH |
| | *camel.component.workday.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.workday.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 |
