replace field action Replace Field Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

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.

Configuration Options

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

Property Name Description Type Default Example

renames

Renames

Required 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

Dependencies

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

  • mvn:org.apache.camel.kamelets:camel-kamelets-utils:4.6.0-SNAPSHOT

  • camel:core

  • camel:jackson

  • 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:replace-field-action"
            parameters:
            .
            .
            .
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml