Package org.opensearch.client.opensearch.ingest

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 Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.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.
static GrokProcessor.Builder	builder()
boolean	equals(Object o)
final String	field()	Required - API name: field
int	hashCode()
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)
GrokProcessor.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
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 org.opensearch.client.opensearch.ingest.ProcessorBase

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant

toProcessor

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

@Nonnull
public final String field()

Required - 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

@Nonnull
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

@Nonnull
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

toBuilder

@Nonnull
public GrokProcessor.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GrokProcessor.Builder,GrokProcessor>

Returns:

a new builder instance.

builder

@Nonnull
public static GrokProcessor.Builder builder()

setupGrokProcessorDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessorBase

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessorBase