Package org.opensearch.client.opensearch.ingest

Class KeyValueProcessor

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

org.opensearch.client.opensearch.ingest.KeyValueProcessor

All Implemented Interfaces:

JsonpSerializable, ProcessorVariant

@JsonpDeserializable
public class KeyValueProcessor
extends ProcessorBase
implements ProcessorVariant

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeyValueProcessor.Builder	Builder for KeyValueProcessor.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<KeyValueProcessor>	_DESERIALIZER	Json deserializer for KeyValueProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
java.util.List<java.lang.String>	excludeKeys()	API name: exclude_keys
java.lang.String	field()	Required - API name: field
java.lang.String	fieldSplit()	Required - API name: field_split
java.lang.Boolean	ignoreMissing()	API name: ignore_missing
java.util.List<java.lang.String>	includeKeys()	API name: include_keys
static KeyValueProcessor	of(java.util.function.Function<KeyValueProcessor.Builder,ObjectBuilder<KeyValueProcessor>> fn)
java.lang.String	prefix()	API name: prefix
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupKeyValueProcessorDeserializer(ObjectDeserializer<KeyValueProcessor.Builder> op)
java.lang.Boolean	stripBrackets()	API name: strip_brackets
java.lang.String	targetField()	API name: target_field
java.lang.String	trimKey()	API name: trim_key
java.lang.String	trimValue()	API name: trim_value
java.lang.String	valueSplit()	Required - API name: value_split

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

if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag

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.opensearch.ingest.ProcessorVariant

_toProcessor

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<KeyValueProcessor> _DESERIALIZER

Json deserializer for KeyValueProcessor

Method Detail

of

public static KeyValueProcessor of(java.util.function.Function<KeyValueProcessor.Builder,ObjectBuilder<KeyValueProcessor>> fn)

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

excludeKeys

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

API name: exclude_keys

field

public final java.lang.String field()

Required - API name: field

fieldSplit

public final java.lang.String fieldSplit()

Required - API name: field_split

ignoreMissing

@Nullable
public final java.lang.Boolean ignoreMissing()

API name: ignore_missing

includeKeys

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

API name: include_keys

prefix

@Nullable
public final java.lang.String prefix()

API name: prefix

stripBrackets

@Nullable
public final java.lang.Boolean stripBrackets()

API name: strip_brackets

targetField

@Nullable
public final java.lang.String targetField()

API name: target_field

trimKey

@Nullable
public final java.lang.String trimKey()

API name: trim_key

trimValue

@Nullable
public final java.lang.String trimValue()

API name: trim_value

valueSplit

public final java.lang.String valueSplit()

Required - API name: value_split

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

Overrides:

serializeInternal in class ProcessorBase

setupKeyValueProcessorDeserializer

protected static void setupKeyValueProcessorDeserializer(ObjectDeserializer<KeyValueProcessor.Builder> op)