blob: 4b0284ac4ee3d7e95d6fc016a4b70e6c4c6bb580 [file] [log] [blame]
// kafka-connector options: START
[[camel-jira-kafka-connector-sink]]
= camel-jira-kafka-connector sink configuration
When using camel-jira-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-jira-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-jira 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.type* | Operation to perform. Consumers: NewIssues, NewComments. Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue, Watchers. See this class javadoc description for more information. One of: [ADDCOMMENT] [ADDISSUE] [ATTACH] [DELETEISSUE] [NEWISSUES] [NEWCOMMENTS] [UPDATEISSUE] [TRANSITIONISSUE] [WATCHERS] [ADDISSUELINK] [ADDWORKLOG] [FETCHISSUE] [FETCHCOMMENTS] | null | HIGH
| *camel.sink.endpoint.delay* | Time in milliseconds to elapse for the next poll. | "6000" | MEDIUM
| *camel.sink.endpoint.jiraUrl* | The Jira server url, example: \http://my_jira.com:8081 | 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.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.accessToken* | (OAuth only) The access token generated by the Jira server. | null | MEDIUM
| *camel.sink.endpoint.consumerKey* | (OAuth only) The consumer key from Jira settings. | null | MEDIUM
| *camel.sink.endpoint.password* | (Basic authentication only) The password to authenticate to the Jira server. Use only if username basic authentication is used. | null | MEDIUM
| *camel.sink.endpoint.privateKey* | (OAuth only) The private key generated by the client to encrypt the conversation to the server. | null | MEDIUM
| *camel.sink.endpoint.username* | (Basic authentication only) The username to authenticate to the Jira server. Use only if OAuth is not enabled on the Jira server. Do not set the username and OAuth token parameter, if they are both set, the username basic authentication takes precedence. | null | MEDIUM
| *camel.sink.endpoint.verificationCode* | (OAuth only) The verification code from Jira generated in the first step of the authorization proccess. | null | MEDIUM
| *camel.component.jira.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.jira.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.jira.configuration* | To use a shared base jira configuration. | null | MEDIUM
|===
// kafka-connector options: END