Set Kafka Key Action
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Sets the key of the Kafka record to the value of a header of the message.
Use it before kafka-sink when the records need a key, for example so that all the records of one customer go to the same partition and stay in order.
Input: any message with the header named by headerName.
Output: the same body. The CamelKafkaKey header, which kafka-sink uses as the record key, is set to the value of that header.
Good to know: to build the key from fields of the body instead, use value-to-key-action.
Configuration Options
The following table summarizes the configuration options available for the set-kafka-key-action Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
Header Name | Required The name of the header whose value becomes the key of the Kafka record. | string | customerId | ||
Force Header Deletion | If true, the header named by | boolean | false |
Dependencies
At runtime, the set-kafka-key-action Kamelet relies upon the presence of the following dependencies:
-
camel:kamelet
Camel JBang usage
Prerequisites
-
You’ve installed JBang.
-
You have executed the following command:
jbang app install camel@apache/camel Supposing you have a file named route.yaml with this content:
- route:
from:
uri: "kamelet:timer-source"
parameters:
period: 10000
message: 'test'
steps:
- to:
uri: "kamelet:set-kafka-key-action"
parameters:
.
.
.
- to:
uri: "kamelet:log-sink" You can now run it directly through the following command
camel run route.yaml