Skip to main content

json

DEPRECATED

This component is deprecated and will be removed in the next major version release. Please consider moving onto alternative components.

# Common config fields, showing default values
label: ""
json:
operator: clean
path: ""
value: ""

Fields

operator

The operator to apply to messages.

Type: string
Default: "clean"
Options: append, clean, copy, delete, explode, flatten, flatten_array, fold_number_array, fold_string_array, move, select, set, split.

path

A dot path specifying the target within the document to the apply the chosen operator to.

Type: string
Default: ""

# Examples
path: foo.bar
path: .
path: some_array.0.id

value

A value to use with the chosen operator (sometimes not applicable). This is a generic field that can be any type.

Type: string
Default: ""

# Examples
value: foo
value: ${!metadata:kafka_key}
value: false
value: 10
value:
key: ${!metadata:kafka_key}
topic: ${!metadata:kafka_topic}

parts

An optional array of message indexes of a batch that the processor should apply to. If left empty all messages are processed. This field is only applicable when batching messages at the input level.

Indexes can be negative, and if so the part will be selected from the end counting backwards starting from -1.

Type: array
Default: []

Alternatives

All functionality of this processor has been superseded by the bloblang processor.