Class GrokProcessor
java.lang.Object
org.opensearch.client.opensearch.ingest.ProcessorBase
org.opensearch.client.opensearch.ingest.GrokProcessor
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,ProcessorVariant,ToCopyableBuilder<GrokProcessor.Builder,GrokProcessor>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class GrokProcessor
extends ProcessorBase
implements ProcessorVariant, ToCopyableBuilder<GrokProcessor.Builder,GrokProcessor>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase
ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<GrokProcessor> Json deserializer forGrokProcessor -
Method Summary
Modifier and TypeMethodDescriptionProcessorvariant kind.static GrokProcessor.Builderbuilder()booleanfinal Stringfield()Required - API name:fieldinthashCode()final BooleanIftrueandfielddoes not exist or isnull, the processor quietly exits without modifying the document.static GrokProcessorA 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 voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.final BooleanWhentrue,_ingest._grok_match_indexwill be inserted into your matched document's metadata with the index into the pattern found inpatternsthat matched.Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase
description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tagMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant
toProcessorMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forGrokProcessor
-
-
Method Details
-
of
-
_processorKind
Processorvariant kind.- Specified by:
_processorKindin interfaceProcessorVariant
-
field
Required - API name:field -
ignoreMissing
Iftrueandfielddoes 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_indexwill be inserted into your matched document's metadata with the index into the pattern found inpatternsthat matched.API name:
trace_match -
serializeInternal
- Overrides:
serializeInternalin classProcessorBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GrokProcessor.Builder,GrokProcessor> - Returns:
- a new builder instance.
-
builder
-
setupGrokProcessorDeserializer
-
hashCode
public int hashCode()- Overrides:
hashCodein classProcessorBase
-
equals
- Overrides:
equalsin classProcessorBase
-