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:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
final String	field()	Required - The field to use for grok expression parsing.
final Boolean	ignoreMissing()	If true and field does not exist or is null, the processor quietly exits without modifying the document.
static GrokProcessor	of(Function<GrokProcessor.Builder,ObjectBuilder<GrokProcessor>> fn)
final Map<String,String>	patternDefinitions()	A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
final List<String>	patterns()	Required - An ordered list of grok expression to match and extract named captures with.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGrokProcessorDeserializer(ObjectDeserializer<GrokProcessor.Builder> op)
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.

Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase

description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.elasticsearch.ingest.ProcessorVariant

_toProcessor

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GrokProcessor> _DESERIALIZER

Json deserializer for GrokProcessor

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

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

serializeInternal

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

Overrides:

serializeInternal in class ProcessorBase

setupGrokProcessorDeserializer

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