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:

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.
KeyValueProcessor.Builder	excludeKeys(java.lang.String value, java.lang.String... values)	API name: exclude_keys
KeyValueProcessor.Builder	excludeKeys(java.util.List<java.lang.String> list)	API name: exclude_keys
KeyValueProcessor.Builder	field(java.lang.String value)	Required - API name: field
KeyValueProcessor.Builder	fieldSplit(java.lang.String value)	Required - API name: field_split
KeyValueProcessor.Builder	ignoreMissing(java.lang.Boolean value)	API name: ignore_missing
KeyValueProcessor.Builder	includeKeys(java.lang.String value, java.lang.String... values)	API name: include_keys
KeyValueProcessor.Builder	includeKeys(java.util.List<java.lang.String> list)	API name: include_keys
KeyValueProcessor.Builder	prefix(java.lang.String value)	API name: prefix
protected KeyValueProcessor.Builder	self()
KeyValueProcessor.Builder	stripBrackets(java.lang.Boolean value)	API name: strip_brackets
KeyValueProcessor.Builder	targetField(java.lang.String value)	API name: target_field
KeyValueProcessor.Builder	trimKey(java.lang.String value)	API name: trim_key
KeyValueProcessor.Builder	trimValue(java.lang.String value)	API name: trim_value
KeyValueProcessor.Builder	valueSplit(java.lang.String value)	Required - API name: value_split

Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder

if_, ignoreFailure, onFailure, onFailure, onFailure, tag

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

excludeKeys

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

API name: exclude_keys

Adds all elements of list to excludeKeys.

excludeKeys

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

API name: exclude_keys

Adds one or more values to excludeKeys.

field

public final KeyValueProcessor.Builder field(java.lang.String value)

Required - API name: field

fieldSplit

public final KeyValueProcessor.Builder fieldSplit(java.lang.String value)

Required - API name: field_split

ignoreMissing

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

API name: ignore_missing

includeKeys

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

API name: include_keys

Adds all elements of list to includeKeys.

includeKeys

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

API name: include_keys

Adds one or more values to includeKeys.

prefix

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

API name: prefix

stripBrackets

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

API name: strip_brackets

targetField

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

API name: target_field

trimKey

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

API name: trim_key

trimValue

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

API name: trim_value

valueSplit

public final KeyValueProcessor.Builder valueSplit(java.lang.String value)

Required - 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:

java.lang.NullPointerException - if some of the required fields are null.