Package co.elastic.clients.elasticsearch.ingest

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KeyValueProcessor	build()	Builds a KeyValueProcessor.
final KeyValueProcessor.Builder	excludeKeys(String value, String... values)	List of keys to exclude from document.
final KeyValueProcessor.Builder	excludeKeys(List<String> list)	List of keys to exclude from document.
final KeyValueProcessor.Builder	field(String value)	Required - The field to be parsed.
final KeyValueProcessor.Builder	fieldSplit(String value)	Required - Regex pattern to use for splitting key-value pairs.
final KeyValueProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist or is null, the processor quietly exits without modifying the document.
final KeyValueProcessor.Builder	includeKeys(String value, String... values)	List of keys to filter and insert into document.
final KeyValueProcessor.Builder	includeKeys(List<String> list)	List of keys to filter and insert into document.
final KeyValueProcessor.Builder	prefix(String value)	Prefix to be added to extracted keys.
protected KeyValueProcessor.Builder	self()
final KeyValueProcessor.Builder	stripBrackets(Boolean value)	If true.
final KeyValueProcessor.Builder	targetField(String value)	The field to insert the extracted keys into.
final KeyValueProcessor.Builder	trimKey(String value)	String of characters to trim from extracted keys.
final KeyValueProcessor.Builder	trimValue(String value)	String of characters to trim from extracted values.
final KeyValueProcessor.Builder	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_, if_, ignoreFailure, onFailure, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

excludeKeys

public final KeyValueProcessor.Builder excludeKeys(List<String> list)

List of keys to exclude from document.

API name: exclude_keys

Adds all elements of list to excludeKeys.

excludeKeys

public final KeyValueProcessor.Builder excludeKeys(String value,
 String... values)

List of keys to exclude from document.

API name: exclude_keys

Adds one or more values to excludeKeys.

field

public final KeyValueProcessor.Builder field(String value)

Required - The field to be parsed. Supports template snippets.

API name: field

fieldSplit

public final KeyValueProcessor.Builder fieldSplit(String value)

Required - Regex pattern to use for splitting key-value pairs.

API name: field_split

ignoreMissing

public final KeyValueProcessor.Builder ignoreMissing(@Nullable
 Boolean value)

If true and field does not exist or is null, the processor quietly exits without modifying the document.

API name: ignore_missing

includeKeys

public final KeyValueProcessor.Builder includeKeys(List<String> list)

List of keys to filter and insert into document. Defaults to including all keys.

API name: include_keys

Adds all elements of list to includeKeys.

includeKeys

public final KeyValueProcessor.Builder includeKeys(String value,
 String... values)

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

public final KeyValueProcessor.Builder prefix(@Nullable
 String value)

Prefix to be added to extracted keys.

API name: prefix

stripBrackets

public final KeyValueProcessor.Builder stripBrackets(@Nullable
 Boolean value)

If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values.

API name: strip_brackets

targetField

public final KeyValueProcessor.Builder targetField(@Nullable
 String value)

The field to insert the extracted keys into. Defaults to the root of the document. Supports template snippets.

API name: target_field

trimKey

public final KeyValueProcessor.Builder trimKey(@Nullable
 String value)

String of characters to trim from extracted keys.

API name: trim_key

trimValue

public final KeyValueProcessor.Builder trimValue(@Nullable
 String value)

String of characters to trim from extracted values.

API name: trim_value

valueSplit

public final KeyValueProcessor.Builder valueSplit(String value)

Required - Regex pattern to use for splitting the key from the value within a key-value pair.

API name: value_split

self

protected KeyValueProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<KeyValueProcessor.Builder>

build

public KeyValueProcessor build()

Builds a KeyValueProcessor.

Specified by:

build in interface ObjectBuilder<KeyValueProcessor>

Throws:

NullPointerException - if some of the required fields are null.