Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 58. Replace Field Action

Replace field with a different key in the message in transit.

  • The required parameter 'renames' is a comma-separated list of colon-delimited renaming pairs like for example 'foo:bar,abc:xyz' and it represents the field rename mappings.
  • The optional parameter 'enabled' represents the fields to include. If specified, only the named fields will be included in the resulting message.
  • The optional parameter 'disabled' represents the fields to exclude. If specified, the listed fields will be excluded from the resulting message. This takes precedence over the 'enabled' parameter.
  • The default value of 'enabled' parameter is 'all', so all the fields of the payload will be included.
  • The default value of 'disabled' parameter is 'none', so no fields of the payload will be excluded.

58.1. Configuration Options
Copy link

The following table summarizes the configuration options available for the replace-field-action Kamelet:

Expand
PropertyNameDescriptionTypeDefaultExample

renames *

Renames

Comma separated list of field with new value to be renamed

string

 

"foo:bar,c1:c2"

disabled

Disabled

Comma separated list of fields to be disabled

string

"none"

 

enabled

Enabled

Comma separated list of fields to be enabled

string

"all"

 
Note

Fields marked with an asterisk (*) are mandatory.

58.2. Dependencies
Copy link

At runtime, the replace-field-action Kamelet relies upon the presence of the following dependencies:

  • github:openshift-integration.kamelet-catalog:camel-kamelets-utils:kamelet-catalog-1.6-SNAPSHOT
  • camel:core
  • camel:jackson
  • camel:kamelet

58.3. Usage
Copy link

This section describes how you can use the replace-field-action.

58.3.1. Knative Action
Copy link

You can use the replace-field-action Kamelet as an intermediate step in a Knative binding.

replace-field-action-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: replace-field-action-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: timer-source
    properties:
      message: "Hello"
  steps:
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: replace-field-action
    properties:
      renames: "foo:bar,c1:c2"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
Copy to Clipboard Toggle word wrap

58.3.1.1. Prerequisite
Copy link

Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

58.3.1.2. Procedure for using the cluster CLI
Copy link

  1. Save the replace-field-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command: 

    oc apply -f replace-field-action-binding.yaml
    Copy to Clipboard Toggle word wrap

58.3.1.3. Procedure for using the Kamel CLI
Copy link

Configure and run the action by using the following command: 

kamel bind timer-source?message=Hello --step replace-field-action -p "step-0.renames=foo:bar,c1:c2" channel:mychannel
Copy to Clipboard Toggle word wrap

This command creates the KameletBinding in the current namespace on the cluster.

58.3.2. Kafka Action
Copy link

You can use the replace-field-action Kamelet as an intermediate step in a Kafka binding.

replace-field-action-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: replace-field-action-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: timer-source
    properties:
      message: "Hello"
  steps:
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: replace-field-action
    properties:
      renames: "foo:bar,c1:c2"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
Copy to Clipboard Toggle word wrap

58.3.2.1. Prerequisites
Copy link

Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

58.3.2.2. Procedure for using the cluster CLI
Copy link

  1. Save the replace-field-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command: 

    oc apply -f replace-field-action-binding.yaml
    Copy to Clipboard Toggle word wrap

58.3.2.3. Procedure for using the Kamel CLI
Copy link

Configure and run the action by using the following command: 

kamel bind timer-source?message=Hello --step replace-field-action -p "step-0.renames=foo:bar,c1:c2" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
Copy to Clipboard Toggle word wrap

This command creates the KameletBinding in the current namespace on the cluster.

58.4. Kamelet source file
Copy link

https://github.com/openshift-integration/kamelet-catalog/replace-field-action.kamelet.yaml

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat