Class KeyValueProcessorDescriptor<T>

Processor to automatically parse messages (or specific event fields) which are of the key=value variety.

Inheritance
object
DescriptorBase<KeyValueProcessorDescriptor<T>, IKeyValueProcessor>
ProcessorDescriptorBase<KeyValueProcessorDescriptor<T>, IKeyValueProcessor>
KeyValueProcessorDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class KeyValueProcessorDescriptor<T> : ProcessorDescriptorBase<KeyValueProcessorDescriptor<T>, IKeyValueProcessor>, IDescriptor, IKeyValueProcessor, 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

ExcludeKeys(IEnumerable<string>)

List of keys to exclude from document

Declaration
public KeyValueProcessorDescriptor<T> ExcludeKeys(IEnumerable<string> excludeKeys)
Parameters
Type Name Description
IEnumerable<string> excludeKeys
Returns
Type Description
KeyValueProcessorDescriptor<T>
| Edit this page View Source

ExcludeKeys(params string[])

List of keys to exclude from document

Declaration
public KeyValueProcessorDescriptor<T> ExcludeKeys(params string[] excludeKeys)
Parameters
Type Name Description
string[] excludeKeys
Returns
Type Description
KeyValueProcessorDescriptor<T>
| Edit this page View Source

Field(Field)

The field to be parsed

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

FieldSplit(string)

Regex pattern to use for splitting key-value pairs

Declaration
public KeyValueProcessorDescriptor<T> FieldSplit(string split)
Parameters
Type Name Description
string split
Returns
Type Description
KeyValueProcessorDescriptor<T>
| Edit this page View Source

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

The field to be parsed

Declaration
public KeyValueProcessorDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
Returns
Type Description
KeyValueProcessorDescriptor<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

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

IncludeKeys(IEnumerable<string>)

List of keys to filter and insert into document. Defaults to including all keys

Declaration
public KeyValueProcessorDescriptor<T> IncludeKeys(IEnumerable<string> includeKeys)
Parameters
Type Name Description
IEnumerable<string> includeKeys
Returns
Type Description
KeyValueProcessorDescriptor<T>
| Edit this page View Source

IncludeKeys(params string[])

List of keys to filter and insert into document. Defaults to including all keys

Declaration
public KeyValueProcessorDescriptor<T> IncludeKeys(params string[] includeKeys)
Parameters
Type Name Description
string[] includeKeys
Returns
Type Description
KeyValueProcessorDescriptor<T>
| Edit this page View Source

Prefix(string)

Prefix to be added to extracted keys

Declaration
public KeyValueProcessorDescriptor<T> Prefix(string prefix)
Parameters
Type Name Description
string prefix
Returns
Type Description
KeyValueProcessorDescriptor<T>
| Edit this page View Source

StripBrackets(bool?)

If true strip brackets (), <>, [] as well as quotes ' and " from extracted values

Declaration
public KeyValueProcessorDescriptor<T> StripBrackets(bool? skip = true)
Parameters
Type Name Description
bool? skip
Returns
Type Description
KeyValueProcessorDescriptor<T>
| Edit this page View Source

TargetField(Field)

The field to insert the extracted keys into. Defaults to the root of the document

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

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

The field to insert the extracted keys into. Defaults to the root of the document

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

TrimKey(string)

String of characters to trim from extracted keys

Declaration
public KeyValueProcessorDescriptor<T> TrimKey(string trimKeys)
Parameters
Type Name Description
string trimKeys
Returns
Type Description
KeyValueProcessorDescriptor<T>
| Edit this page View Source

TrimValue(string)

String of characters to trim from extracted values

Declaration
public KeyValueProcessorDescriptor<T> TrimValue(string trimValues)
Parameters
Type Name Description
string trimValues
Returns
Type Description
KeyValueProcessorDescriptor<T>
| Edit this page View Source

ValueSplit(string)

Regex pattern to use for splitting the key from the value within a key-value pair

Declaration
public KeyValueProcessorDescriptor<T> ValueSplit(string split)
Parameters
Type Name Description
string split
Returns
Type Description
KeyValueProcessorDescriptor<T>

Implements

Extension Methods