Package co.elastic.clients.elasticsearch.ingest

Class RedactProcessor

java.lang.Object
co.elastic.clients.elasticsearch.ingest.ProcessorBase
co.elastic.clients.elasticsearch.ingest.RedactProcessor
All Implemented Interfaces:
ProcessorVariant, JsonpSerializable
@JsonpDeserializable public class RedactProcessor extends ProcessorBase implements ProcessorVariant
See Also:

  • Field Details

  • Method Details

    • of

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

    • _processorKind

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

    • field

      public final String field()
      Required - The field to be redacted

      API name: field

    • patterns

      public final List<String> patterns()
      Required - A list of grok expressions to match and redact named captures with

      API name: patterns

    • patternDefinitions

      public final Map<String,String> patternDefinitions()
      API name: pattern_definitions

    • prefix

      @Nullable public final String prefix()
      Start a redacted section with this token

      API name: prefix

    • suffix

      @Nullable public final String suffix()
      End a redacted section with this token

      API name: suffix

    • 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

    • skipIfUnlicensed

      @Nullable public final Boolean skipIfUnlicensed()
      If true and the current license does not support running redact processors, then the processor quietly exits without modifying the document

      API name: skip_if_unlicensed

    • traceRedact

      @Nullable public final Boolean traceRedact()
      If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted

      API name: trace_redact

    • serializeInternal

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

    • setupRedactProcessorDeserializer

      protected static void setupRedactProcessorDeserializer(ObjectDeserializer<RedactProcessor.Builder> op)