Interface IKeyValueProcessor

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

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IKeyValueProcessor : IProcessor

Properties

| Edit this page View Source

ExcludeKeys

List of keys to exclude from document

Declaration
[DataMember(Name = "exclude_keys")]
IEnumerable<string> ExcludeKeys { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

Field

The field to be parsed

Declaration
[DataMember(Name = "field")]
Field Field { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

FieldSplit

Regex pattern to use for splitting key-value pairs

Declaration
[DataMember(Name = "field_split")]
string FieldSplit { get; set; }
Property Value
Type Description
string
| Edit this page View Source

IgnoreMissing

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

Declaration
[DataMember(Name = "ignore_missing")]
bool? IgnoreMissing { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IncludeKeys

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

Declaration
[DataMember(Name = "include_keys")]
IEnumerable<string> IncludeKeys { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

Prefix

Prefix to be added to extracted keys

Declaration
[DataMember(Name = "prefix")]
string Prefix { get; set; }
Property Value
Type Description
string
| Edit this page View Source

StripBrackets

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

Declaration
[DataMember(Name = "strip_brackets")]
bool? StripBrackets { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

TargetField

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

Declaration
[DataMember(Name = "target_field")]
Field TargetField { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

TrimKey

String of characters to trim from extracted keys

Declaration
[DataMember(Name = "trim_key")]
string TrimKey { get; set; }
Property Value
Type Description
string
| Edit this page View Source

TrimValue

String of characters to trim from extracted values

Declaration
[DataMember(Name = "trim_value")]
string TrimValue { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ValueSplit

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

Declaration
[DataMember(Name = "value_split")]
string ValueSplit { get; set; }
Property Value
Type Description
string

Extension Methods