Class GrokProcessorDescriptor<T>

Inheritance
object
DescriptorBase<GrokProcessorDescriptor<T>, IGrokProcessor>
ProcessorDescriptorBase<GrokProcessorDescriptor<T>, IGrokProcessor>
GrokProcessorDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GrokProcessorDescriptor<T> : ProcessorDescriptorBase<GrokProcessorDescriptor<T>, IGrokProcessor>, IDescriptor, IGrokProcessor, IProcessor where T : class
Type Parameters
Name Description
T

Properties

| Edit this page View Source

Name

Declaration
protected override string Name { get; }
Property Value
Type Description
string
Overrides

Methods

| Edit this page View Source

Field(Field)

The field to use for grok expression parsing

Declaration
public GrokProcessorDescriptor<T> Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
GrokProcessorDescriptor<T>
| Edit this page View Source

Field<TValue>(Expression<Func<T, TValue>>)

The field to use for grok expression parsing

Declaration
public GrokProcessorDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
Returns
Type Description
GrokProcessorDescriptor<T>
Type Parameters
Name Description
TValue
| Edit this page View Source

IgnoreMissing(bool?)

If true and Field does not exist or is null, the processor quietly exits without modifying the document. Default is false

Declaration
public GrokProcessorDescriptor<T> IgnoreMissing(bool? ignoreMissing = true)
Parameters
Type Name Description
bool? ignoreMissing
Returns
Type Description
GrokProcessorDescriptor<T>
| Edit this page View Source

PatternDefinitions(Func<FluentDictionary<string, string>, FluentDictionary<string, string>>)

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.

Declaration
public GrokProcessorDescriptor<T> PatternDefinitions(Func<FluentDictionary<string, string>, FluentDictionary<string, string>> patternDefinitions)
Parameters
Type Name Description
Func<FluentDictionary<string, string>, FluentDictionary<string, string>> patternDefinitions
Returns
Type Description
GrokProcessorDescriptor<T>
| Edit this page View Source

Patterns(IEnumerable<string>)

An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches.

Declaration
public GrokProcessorDescriptor<T> Patterns(IEnumerable<string> patterns)
Parameters
Type Name Description
IEnumerable<string> patterns
Returns
Type Description
GrokProcessorDescriptor<T>
| Edit this page View Source

Patterns(params string[])

An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches.

Declaration
public GrokProcessorDescriptor<T> Patterns(params string[] patterns)
Parameters
Type Name Description
string[] patterns
Returns
Type Description
GrokProcessorDescriptor<T>
| Edit this page View Source

TraceMatch(bool?)

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.

Declaration
public GrokProcessorDescriptor<T> TraceMatch(bool? traceMatch = true)
Parameters
Type Name Description
bool? traceMatch
Returns
Type Description
GrokProcessorDescriptor<T>

Implements

Extension Methods