.. _replacefield:

============
ReplaceField
============

Description
-----------
Filter or rename fields within a Struct or Map.

Use the concrete transformation type designed for the record key (``org.apache.kafka.connect.transforms.ReplaceField$Key``) or value (``org.apache.kafka.connect.transforms.ReplaceField$Value``).


Properties
----------

.. list-table::
   :header-rows: 1
   :widths: 15 30 10 10 10 10

   *  - Name
      - Description
      - Type
      - Default
      - Valid Values
      - Importance
   *  - ``blacklist``
      - Fields to exclude from the resulting Struct or Map. This takes precedence over the whitelist.
      - list
      - ""
      -
      - medium
   *  - ``renames``
      - Field rename mappings.
      - list
      - ""
      - comma-separated list of colon-delimited renaming pairs, e.g. ``foo:bar,abc:xyz``
      - medium
   *  - ``whitelist``
      - Fields to include. If specified, only the named fields will be included in the resulting Struct or Map.
      - list
      - ""
      -
      - medium