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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aKeyValueProcessor.copy()Create a new builderCopyableBuilderthat is a copy of this one.excludeKeys(String value, String... values) List of keys to exclude from document.excludeKeys(List<String> list) List of keys to exclude from document.Required - API name:fieldfieldSplit(String value) Required - Regex pattern to use for splitting key-value pairs.ignoreMissing(Boolean value) Iftrueandfielddoes 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.Builderself()stripBrackets(Boolean value) Iftrue.targetField(String value) API name:target_fieldString 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 org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder
description, if_, ignoreFailure, onFailure, onFailure, onFailure, tagMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<KeyValueProcessor.Builder,KeyValueProcessor> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classProcessorBase.AbstractBuilder<KeyValueProcessor.Builder>
-
excludeKeys
List of keys to exclude from document.API name:
exclude_keysAdds all elements of
listtoexcludeKeys. -
excludeKeys
List of keys to exclude from document.API name:
exclude_keysAdds one or more values to
excludeKeys. -
field
Required - API name:field -
fieldSplit
Required - Regex pattern to use for splitting key-value pairs.API name:
field_split -
ignoreMissing
Iftrueandfielddoes 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_keysAdds all elements of
listtoincludeKeys. -
includeKeys
List of keys to filter and insert into document. Defaults to including all keys.API name:
include_keysAdds 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
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 -
build
Builds aKeyValueProcessor.- Specified by:
buildin interfaceObjectBuilder<KeyValueProcessor>- Throws:
NullPointerException- if some of the required fields are null.
-