Package org.opensearch.client.opensearch.ingest

Class KeyValueProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<KeyValueProcessor.Builder>

org.opensearch.client.opensearch.ingest.KeyValueProcessor.Builder

All Implemented Interfaces:

CopyableBuilder<KeyValueProcessor.Builder,KeyValueProcessor>, MutableBuilder<KeyValueProcessor.Builder,KeyValueProcessor>, ObjectBuilder<KeyValueProcessor>

Enclosing class:

KeyValueProcessor

public static class KeyValueProcessor.Builder
extends ProcessorBase.AbstractBuilder<KeyValueProcessor.Builder>
implements CopyableBuilder<KeyValueProcessor.Builder,KeyValueProcessor>

Builder for KeyValueProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KeyValueProcessor	build()	Builds a KeyValueProcessor.
KeyValueProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
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 - API name: field
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)	API name: target_field
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 org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder

description, if_, ignoreFailure, onFailure, onFailure, onFailure, tag

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public KeyValueProcessor.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<KeyValueProcessor.Builder,KeyValueProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected KeyValueProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<KeyValueProcessor.Builder>

excludeKeys

@Nonnull
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

@Nonnull
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

@Nonnull
public final KeyValueProcessor.Builder field(String value)

Required - API name: field

fieldSplit

@Nonnull
public final KeyValueProcessor.Builder fieldSplit(String value)

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

API name: field_split

ignoreMissing

@Nonnull
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

@Nonnull
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

@Nonnull
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

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

Prefix to be added to extracted keys.

API name: prefix

stripBrackets

@Nonnull
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

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

API name: target_field

trimKey

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

String of characters to trim from extracted keys.

API name: trim_key

trimValue

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

String of characters to trim from extracted values.

API name: trim_value

valueSplit

@Nonnull
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

build

@Nonnull
public KeyValueProcessor build()

Builds a KeyValueProcessor.

Specified by:

build in interface ObjectBuilder<KeyValueProcessor>

Throws:

NullPointerException - if some of the required fields are null.