Package co.elastic.clients.elasticsearch.ingest

Class GrokProcessor

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

  • Field Details

  • Method Details

    • of

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

    • _processorKind

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

    • ecsCompatibility

      @Nullable public final String ecsCompatibility()
      Must be disabled or v1. If v1, the processor uses patterns with Elastic Common Schema (ECS) field names.

      API name: ecs_compatibility

    • field

      public final String field()
      Required - The field to use for grok expression parsing.

      API name: field

    • 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

    • patternDefinitions

      public final Map<String,String> patternDefinitions()
      A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. Patterns matching existing names will override the pre-existing definition.

      API name: pattern_definitions

    • patterns

      public final List<String> patterns()
      Required - An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches.

      API name: patterns

    • traceMatch

      @Nullable public final Boolean traceMatch()
      When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched.

      API name: trace_match

    • validateOnly

      @Nullable public final Boolean validateOnly()
      When true, the processor does matching but does not extract structured fields

      API name: validate_only

    • serializeInternal

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

    • rebuild

      public GrokProcessor.Builder rebuild()
      Returns:
      New GrokProcessor.Builder initialized with field values of this instance

    • setupGrokProcessorDeserializer

      protected static void setupGrokProcessorDeserializer(ObjectDeserializer<GrokProcessor.Builder> op)