Class KeyValueProcessor
java.lang.Object
co.elastic.clients.elasticsearch.ingest.ProcessorBase
co.elastic.clients.elasticsearch.ingest.KeyValueProcessor
- All Implemented Interfaces:
ProcessorVariant
,JsonpSerializable
@JsonpDeserializable
public class KeyValueProcessor
extends ProcessorBase
implements ProcessorVariant
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase
ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<KeyValueProcessor>
Json deserializer forKeyValueProcessor
-
Method Summary
Modifier and TypeMethodDescriptionProcessor variant kind.List of keys to exclude from document.final String
field()
Required - The field to be parsed.final String
Required - Regex pattern to use for splitting key-value pairs.final Boolean
Iftrue
andfield
does not exist or isnull
, the processor quietly exits without modifying the document.List of keys to filter and insert into document.static KeyValueProcessor
final String
prefix()
Prefix to be added to extracted keys.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final Boolean
Iftrue
.final String
The field to insert the extracted keys into.final String
trimKey()
String of characters to trim from extracted keys.final String
String of characters to trim from extracted values.final String
Required - Regex pattern to use for splitting the key from the value within a key-value pair.Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase
description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch.ingest.ProcessorVariant
_toProcessor
-
Field Details
-
_DESERIALIZER
Json deserializer forKeyValueProcessor
-
-
Method Details
-
of
public static KeyValueProcessor of(Function<KeyValueProcessor.Builder, ObjectBuilder<KeyValueProcessor>> fn) -
_processorKind
Processor variant kind.- Specified by:
_processorKind
in interfaceProcessorVariant
-
excludeKeys
List of keys to exclude from document.API name:
exclude_keys
-
field
Required - The field to be parsed. Supports template snippets.API name:
field
-
fieldSplit
Required - Regex pattern to use for splitting key-value pairs.API name:
field_split
-
ignoreMissing
Iftrue
andfield
does not exist or isnull
, the processor quietly exits without modifying the document.API name:
ignore_missing
-
includeKeys
List of keys to filter and insert into document. Defaults to including all keys.API name:
include_keys
-
prefix
Prefix to be added to extracted keys.API name:
prefix
-
stripBrackets
Iftrue
. strip brackets()
,<>
,[]
as well as quotes'
and"
from extracted values.API name:
strip_brackets
-
targetField
The field to insert the extracted keys into. Defaults to the root of the document. Supports template snippets.API name:
target_field
-
trimKey
String of characters to trim from extracted keys.API name:
trim_key
-
trimValue
String of characters to trim from extracted values.API name:
trim_value
-
valueSplit
Required - Regex pattern to use for splitting the key from the value within a key-value pair.API name:
value_split
-
serializeInternal
- Overrides:
serializeInternal
in classProcessorBase
-
setupKeyValueProcessorDeserializer
protected static void setupKeyValueProcessorDeserializer(ObjectDeserializer<KeyValueProcessor.Builder> op)
-