blob: e0a833c429816812dbfa71709ba949543e869dbd [file] [log] [blame]
// kafka-connector options: START
[[camel-github-kafka-connector-sink]]
= camel-github-kafka-connector sink configuration
When using camel-github-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-github-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-github 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.type* | What git operation to execute One of: [CLOSEPULLREQUEST] [PULLREQUESTCOMMENT] [COMMIT] [PULLREQUEST] [TAG] [PULLREQUESTSTATE] [PULLREQUESTFILES] [GETCOMMITFILE] [CREATEISSUE] | null | HIGH
| *camel.sink.endpoint.oauthToken* | GitHub OAuth token, required unless username & password are provided | null | MEDIUM
| *camel.sink.endpoint.password* | GitHub password, required unless oauthToken is provided | null | MEDIUM
| *camel.sink.endpoint.repoName* | GitHub repository name | null | HIGH
| *camel.sink.endpoint.repoOwner* | GitHub repository owner (organization) | null | HIGH
| *camel.sink.endpoint.username* | GitHub username, required unless oauthToken is provided | null | MEDIUM
| *camel.sink.endpoint.encoding* | To use the given encoding when getting a git commit file | 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.state* | To set git commit status state One of: [error] [failure] [pending] [success] | null | MEDIUM
| *camel.sink.endpoint.targetUrl* | To set git commit status target url | null | 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.component.github.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.github.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