camel-github-kafka-connector sink configuration

Connector Description: Interact with the GitHub API.

When using camel-github-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<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>

To use this sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.github.CamelGithubSinkConnector

The camel-github sink connector supports 11 options, which are listed below.

Name Description Default Priority

camel.sink.path.type

Required What git operation to execute One of: [CLOSEPULLREQUEST] [PULLREQUESTCOMMENT] [COMMIT] [PULLREQUEST] [TAG] [PULLREQUESTSTATE] [PULLREQUESTFILES] [GETCOMMITFILE] [CREATEISSUE] [EVENT].

Enum values:

  • CLOSEPULLREQUEST

  • PULLREQUESTCOMMENT

  • COMMIT

  • PULLREQUEST

  • TAG

  • PULLREQUESTSTATE

  • PULLREQUESTFILES

  • GETCOMMITFILE

  • CREATEISSUE

  • EVENT

HIGH

camel.sink.endpoint.repoName

Required GitHub repository name.

HIGH

camel.sink.endpoint.repoOwner

Required GitHub repository owner (organization).

HIGH

camel.sink.endpoint.encoding

To use the given encoding when getting a git commit file.

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].

Enum values:

  • error

  • failure

  • pending

  • success

MEDIUM

camel.sink.endpoint.targetUrl

To set git commit status target url.

MEDIUM

camel.sink.endpoint.oauthToken

GitHub OAuth token. Must be configured on either component or endpoint.

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.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

camel.component.github.oauthToken

GitHub OAuth token. Must be configured on either component or endpoint.

MEDIUM

The camel-github sink connector has no converters out of the box.

The camel-github sink connector supports 1 transforms out of the box, which are listed below.

  • org.apache.camel.kafkaconnector.github.transformers.EventTypeTransforms

The camel-github sink connector has no aggregation strategies out of the box.

Back to top