Interface IUserAgentProcessor

The user_agent processor extracts details from the user agent string a browser sends with its web requests. This processor adds this information by default under the user_agent field. The ingest-user-agent plugin ships by default with the regexes.yaml made available by uap-java with an Apache 2.0 license.

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

Requires the UserAgent Processor Plugin to be installed on the cluster.

Properties

| Edit this page View Source

Field

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

IgnoreMissing

If true and field does not exist, 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

Properties

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

RegexFile

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

TargetField

Declaration
[DataMember(Name = "target_field")]
Field TargetField { get; set; }
Property Value
Type Description
Field

Extension Methods