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, PlainJsonSerializable, ProcessorVariant, ToCopyableBuilder<KeyValueProcessor.Builder,KeyValueProcessor>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class KeyValueProcessor extends ProcessorBase implements ProcessorVariant, ToCopyableBuilder<KeyValueProcessor.Builder,KeyValueProcessor>

  • Field Details

  • Method Details

    • of

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

    • _processorKind

      public Processor.Kind _processorKind()
      Processor variant kind.
      Specified by:
      _processorKind in interface ProcessorVariant

    • excludeKeys

      @Nonnull public final List<String> excludeKeys()
      List of keys to exclude from document.

      API name: exclude_keys

    • field

      @Nonnull public final String field()
      Required - API name: field

    • fieldSplit

      @Nonnull public final String fieldSplit()
      Required - Regex pattern to use for splitting key-value pairs.

      API name: field_split

    • ignoreMissing

      @Nullable public final Boolean ignoreMissing()
      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 List<String> includeKeys()
      List of keys to filter and insert into document. Defaults to including all keys.

      API name: include_keys

    • prefix

      @Nullable public final String prefix()
      Prefix to be added to extracted keys.

      API name: prefix

    • stripBrackets

      @Nullable public final Boolean stripBrackets()
      If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values.

      API name: strip_brackets

    • targetField

      @Nullable public final String targetField()
      API name: target_field

    • trimKey

      @Nullable public final String trimKey()
      String of characters to trim from extracted keys.

      API name: trim_key

    • trimValue

      @Nullable public final String trimValue()
      String of characters to trim from extracted values.

      API name: trim_value

    • valueSplit

      @Nonnull public final String valueSplit()
      Required - Regex pattern to use for splitting the key from the value within a key-value pair.

      API name: value_split

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class ProcessorBase

    • toBuilder

      @Nonnull public KeyValueProcessor.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<KeyValueProcessor.Builder,KeyValueProcessor>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static KeyValueProcessor.Builder builder()

    • setupKeyValueProcessorDeserializer

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class ProcessorBase

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class ProcessorBase