Class KeyValueProcessor.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder<KeyValueProcessor.Builder>
co.elastic.clients.elasticsearch.ingest.KeyValueProcessor.Builder
- All Implemented Interfaces:
WithJson<KeyValueProcessor.Builder>
,ObjectBuilder<KeyValueProcessor>
- Enclosing class:
- KeyValueProcessor
public static class KeyValueProcessor.Builder
extends ProcessorBase.AbstractBuilder<KeyValueProcessor.Builder>
implements ObjectBuilder<KeyValueProcessor>
Builder for
KeyValueProcessor
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aKeyValueProcessor
.excludeKeys
(String value, String... values) List of keys to exclude from document.excludeKeys
(List<String> list) List of keys to exclude from document.Required - The field to be parsed.fieldSplit
(String value) Required - Regex pattern to use for splitting key-value pairs.ignoreMissing
(Boolean value) Iftrue
andfield
does not exist or isnull
, the processor quietly exits without modifying the document.includeKeys
(String value, String... values) List of keys to filter and insert into document.includeKeys
(List<String> list) List of keys to filter and insert into document.Prefix to be added to extracted keys.protected KeyValueProcessor.Builder
self()
stripBrackets
(Boolean value) Iftrue
.targetField
(String value) The field to insert the extracted keys into.String of characters to trim from extracted keys.String of characters to trim from extracted values.valueSplit
(String value) 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.AbstractBuilder
description, if_, ignoreFailure, onFailure, onFailure, onFailure, tag
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
excludeKeys
List of keys to exclude from document.API name:
exclude_keys
Adds all elements of
list
toexcludeKeys
. -
excludeKeys
List of keys to exclude from document.API name:
exclude_keys
Adds one or more values to
excludeKeys
. -
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
Adds all elements of
list
toincludeKeys
. -
includeKeys
List of keys to filter and insert into document. Defaults to including all keys.API name:
include_keys
Adds one or more values to
includeKeys
. -
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
-
self
- Specified by:
self
in classProcessorBase.AbstractBuilder<KeyValueProcessor.Builder>
-
build
Builds aKeyValueProcessor
.- Specified by:
build
in interfaceObjectBuilder<KeyValueProcessor>
- Throws:
NullPointerException
- if some of the required fields are null.
-