Class GrokProcessor
java.lang.Object
co.elastic.clients.elasticsearch.ingest.ProcessorBase
co.elastic.clients.elasticsearch.ingest.GrokProcessor
- All Implemented Interfaces:
ProcessorVariant
,JsonpSerializable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase
ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GrokProcessor>
Json deserializer forGrokProcessor
-
Method Summary
Modifier and TypeMethodDescriptionProcessor variant kind.final String
field()
Required - The field to use for grok expression parsing.final Boolean
Iftrue
andfield
does not exist or isnull
, the processor quietly exits without modifying the document.static GrokProcessor
A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.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
final Boolean
Whentrue
,_ingest._grok_match_index
will be inserted into your matched document’s metadata with the index into the pattern found inpatterns
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
Json deserializer forGrokProcessor
-
-
Method Details
-
of
-
_processorKind
Processor variant kind.- Specified by:
_processorKind
in interfaceProcessorVariant
-
field
Required - The field to use for grok expression parsing.API name:
field
-
ignoreMissing
Iftrue
andfield
does not exist or isnull
, the processor quietly exits without modifying the document.API name:
ignore_missing
-
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
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
Whentrue
,_ingest._grok_match_index
will be inserted into your matched document’s metadata with the index into the pattern found inpatterns
that matched.API name:
trace_match
-
serializeInternal
- Overrides:
serializeInternal
in classProcessorBase
-
setupGrokProcessorDeserializer
-