Class GrokProcessor.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder<GrokProcessor.Builder>
co.elastic.clients.elasticsearch.ingest.GrokProcessor.Builder
- All Implemented Interfaces:
WithJson<GrokProcessor.Builder>
,ObjectBuilder<GrokProcessor>
- Enclosing class:
- GrokProcessor
public static class GrokProcessor.Builder
extends ProcessorBase.AbstractBuilder<GrokProcessor.Builder>
implements ObjectBuilder<GrokProcessor>
Builder for
GrokProcessor
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGrokProcessor
.final GrokProcessor.Builder
Required - The field to use for grok expression parsing.final GrokProcessor.Builder
ignoreMissing
(Boolean value) Iftrue
andfield
does not exist or isnull
, the processor quietly exits without modifying the document.final GrokProcessor.Builder
patternDefinitions
(String key, String value) A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.final GrokProcessor.Builder
patternDefinitions
(Map<String, String> map) A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.final GrokProcessor.Builder
Required - An ordered list of grok expression to match and extract named captures with.final GrokProcessor.Builder
Required - An ordered list of grok expression to match and extract named captures with.protected GrokProcessor.Builder
self()
final GrokProcessor.Builder
traceMatch
(Boolean value) 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.AbstractBuilder
description, if_, ignoreFailure, onFailure, onFailure, onFailure, tag
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all entries of
map
topatternDefinitions
. -
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
Adds an entry to
patternDefinitions
. -
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
Adds all elements of
list
topatterns
. -
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
Adds one or more values to
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
-
self
- Specified by:
self
in classProcessorBase.AbstractBuilder<GrokProcessor.Builder>
-
build
Builds aGrokProcessor
.- Specified by:
build
in interfaceObjectBuilder<GrokProcessor>
- Throws:
NullPointerException
- if some of the required fields are null.
-